Development

Guides

• Development guide
  • Scope of contributions
  • Environment set up
  • Code formatting and linting with pre-commit
  • Running tests via tox
  • Running tests through pytest
  • Building documentation
  • Updating the change log
  • Style guide
• Release procedure
  • Regular releases
  • Backport releases

Architecture

• Theming architecture overview
  • Handling CSS, JavaScript, and image assets
  • Handling Jinja HTML templates

Reference

• Python API reference
  • documenteer.conf
  • documenteer.ext
  • documenteer.requestsutils
  • documenteer.sphinxconfig
  • documenteer.sphinxext
  • documenteer.sphinxrunner
  • documenteer.stackdocs