Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
pymagglobal
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
sec23
korte
pymagglobal
Commits
d19dda86
Commit
d19dda86
authored
4 years ago
by
Stefan Mauerberger
Browse files
Options
Downloads
Patches
Plain Diff
Using sphinx-autodoc and sphinx-napoleon for package documentation
parent
837b61aa
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!1
Sphinx Documentation
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/package_documentation.rst
+28
-1
28 additions, 1 deletion
docs/package_documentation.rst
with
28 additions
and
1 deletion
docs/package_documentation.rst
+
28
−
1
View file @
d19dda86
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:
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment