Documenting your Saltext

Your Salt extension’s documentation is generated using sphinx.

The environment setup and sphinx invocation are managed by nox.

Quick links

• Building documentation
  • Prerequisites
  • Build once
  • Live preview
• Writing documentation
  • Markup language
    • docs/*
    • Docstrings
  • Tagging changes between versions
  • Cross-references
    • Entities
      • Modules
      • Functions
      • Salt master configuration
      • Salt minion configuration
    • Arbitrary anchors
  • Admonitions
  • Tabs
• Publishing documentation
  • Setup
  • Further steps
    • Docs URL in metadata
    • Repository website
• Keeping a changelog
  • Procedure
  • Example
  • Building the changelog