Dans Sphinx Template

Contents:

  • Hello world
  • Syntax Examples
  • Styleguide and conventions
  • Working with conf.py
  • References and resources
Dans Sphinx Template
  • »
  • Dan’s Sphinx Template [DansSphinxTemplate] v0.0.3
  • View page source

Dan’s Sphinx Template [DansSphinxTemplate] v0.0.3¶

Because the sphinx-quickstart util is sometimes not specific enough for my needs.

  • Hello world - This is an example of how to do a doc, cause I keep forgetting.

Full table of contents¶

Contents:

  • Hello world
    • Second header
    • Third header
  • Syntax Examples
    • Table of contents
      • Site-wide TOC indexing with :toctree:
      • Local/per-page TOC with :contents:
    • Tables
      • Simple tables
      • Grid Table Syntax
      • CSV Table
      • Sublime shortcuts for OSX
      • References
    • Images
      • Basic image
    • Including code files and partial RST content
      • :include: for concatenating RST for rendering
      • :literalinclude: for including file as code block
    • Plugins and extensions
      • Intersphinx
  • Styleguide and conventions
    • File and directory naming
      • Content
      • Chapter/section subdirectories
    • Commonly used roles
      • :any: cross-reference catch-all
      • Mark filenames with :file:
      • Mark keyboard actions with :kbd:
      • Mark regexes with :regexp:
  • Working with conf.py
    • The setup function

More stuff:

  • References and resources
    • Official documentation
    • Sphinx docs to learn from
Next

© Copyright 2020, Dan Nguyen

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