Documentation Tool - ShajadulKarim/LevelUp GitHub Wiki
Sphinx:
In our project, we will use Sphinx as the Documentation Generator Tool
Installation Process
Sphinx is used for creating documentation.We will be following the YouTube Video to generate documentation for our Python source codes. Sample procedure from source code
accounts.models module
----------------------
.. automodule:: accounts.models
:members:
:undoc-members:
:show-inheritance:
accounts.tests module
---------------------
.. automodule:: accounts.tests
:members:
:undoc-members:
:show-inheritance:
accounts.views module
---------------------
.. automodule:: accounts.views
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: accounts
:members:
:undoc-members:
:show-inheritance: