Commit d19dda86 authored by Stefan Mauerberger's avatar Stefan Mauerberger
Browse files

Using sphinx-autodoc and sphinx-napoleon for package documentation

parent 837b61aa
Package Documentation
=====================
The modules will documented here ...
Attributes exposed to the package
.. automodule:: pymagglobal
:members:
Pymagglobal
***********
The core module
.. automodule:: pymagglobal.pymagglobal
:members:
Utilities
*********
.. automodule:: pymagglobal.utils
:members:
Argument Parser & Main Program
******************************
.. automodule:: pymagglobal.__main__
:members:
Commands
********
Just a bunch of wrapper functions
.. automodule:: pymagglobal.pymagglobal
:members:
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment