py.test --cov-report term-missing --cov myproj tests/
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
""" | |
main.py | |
==================================== | |
The core module of my example project | |
""" | |
def about_me(your_name): | |
""" | |
Return the most important thing about a person. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Welcome to Getting Started with Sphinx's documentation! | |
======================================================= | |
.. automodule:: my_project.main | |
:members: | |
.. toctree:: | |
:maxdepth: 2 | |
:caption: Contents: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Getting Started with Sphinx and Autodoc | |
####################################### | |
.. automodule:: my_project.main | |
:members: | |
.. toctree:: | |
:maxdepth: 2 | |
:caption: Contents: |