Dans Sphinx Template

Contents:

  • Hello world
  • Syntax Examples
  • Styleguide and conventions
    • File and directory naming
    • Commonly used roles
  • Working with conf.py
  • References and resources
Dans Sphinx Template
  • »
  • Styleguide and conventions
  • View page source

Styleguide and conventionsΒΆ

Contents:

  • File and directory naming
    • Content
    • Chapter/section subdirectories
      • index.rst
      • Assets subdirectories
  • Commonly used roles
    • :any: cross-reference catch-all
    • Mark filenames with :file:
    • Mark keyboard actions with :kbd:
    • Mark regexes with :regexp:
Next Previous

© Copyright 2020, Dan Nguyen

Built with Sphinx using a theme provided by Read the Docs.