IDM style guide and doc guidance

This documentation set includes the “nuts and bolts” information about our documentation toolchain, standards, and how to write docs and Python docstrings. For a high-level overview of our documentation philosophy, see https://wiki.idmod.org/display/SP/Software+Documentation. This docset includes information on the following:

• How to engage with the content team

• How to set up new documentation sets for software projects

• The documentation build toolchain

• Getting started with RST, Sphinx, and Read the Docs

• Style guidelines for docstrings and RST files

If you still have questions after consulting the information here or notice information that is out of date or incomplete in some way, file a ticket in the doc-guidance repository so we can update the guidance.

• Get started writing
  • reStructuredText primer
  • RST templates
  • Building README files into HTML docs
  • Google style Python docstrings
  • EMOD documentation
  • Add Jupyter notebooks to documentation
• Documentation toolchain
  • Text editors: Write the source
  • Parameter DB: Store and export EMOD parameter info
  • GitHub: Store the source files
  • Sphinx: Build the HTML output
    • Configure the build
    • Sphinx build troubleshooting
  • Read the Docs: Host the docs
  • R package toolchain
• Grammar and style guide
• IDM user personas
• Frequently asked questions