Documentation

• The Pyddg Documentation consists of:

  • the Users Guide (created from the .rst files located in pyddg/docs)

  • the Developers Guide (also created from .rst files)

  • the API docs (generated automatically from all docstrings of functions and classes)

• The version of the documentation on develop can be found online and is updated automatically when pushing onto develop

• Building the documentation
• Docstring Conventions
• Users Guide Conventions & Writing Entries
• How multiple versions of the docs are created