sphinxcontrib-specdomain
latest
  • How to use Sphinx to Document SPEC Macro Source Code Files
    • How to Download and Install the SPEC support into Sphinx
    • How to Create and Configure a Sphinx project to Document SPEC Macros
    • How to Build the Documentation from a Sphinx project
    • How to Markup a SPEC Macro File
  • Examples
  • SPEC Documentation Conventions
  • SPEC Documentation Style Guide
  • Documenting SPEC Code
  • Other matters
  • References
sphinxcontrib-specdomain
  • Docs »
  • How to use Sphinx to Document SPEC Macro Source Code Files
  • Edit on GitHub

How to use Sphinx to Document SPEC Macro Source Code FilesΒΆ

  • How to Download and Install the SPEC support into Sphinx
    • use package manager
    • install from source
  • How to Create and Configure a Sphinx project to Document SPEC Macros
    • Decide which configuration
    • Create the Sphinx documentation tree
    • Configure: Changes to conf.py
  • How to Build the Documentation from a Sphinx project
    • Test
  • How to Markup a SPEC Macro File
    • Basic SPEC Macro file
    • Create a Sphinx Project
    • Apply Markup
    • Final Results
Next Previous

© Copyright 2012-2014, BCDA, Advanced Photon Source, Argonne National Laboratory. Revision 30972b15.

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