Documenting SPEC Macro Source Code with Sphinx

This Python package is an extension for Sphinx (http://sphinx.pocoo.org/), to document SPEC macro source code files. SPEC (http://www.certif.com) is control software for X-Ray Diffraction and Data Acquisition of scientific instruments.

This code extracts useful documentation from SPEC macro source code files.

home:http://specdomain.readthedocs.org git:https://github.com/prjemian/specdomain PyPI:https://pypi.python.org/pypi/sphinxcontrib-specdomain

Contents

• 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
  • Simple Example to Document a SPEC Macro File
  • Example with more extensive reST markup
  • Example with no reST markup
• SPEC Documentation Conventions
  • Documentation in comment blocks
• SPEC Documentation Style Guide
  • The concept of docstrings
  • Documentation of code objects
• Documenting SPEC Code
  • Documenting SPEC File Directories
  • Documenting SPEC Files
  • SPEC Extended Comments
  • Describing SPEC objects
  • Cross-referencing SPEC objects
  • Undeclared Variables
• Other matters
  • Downloads
  • Objectives
  • TO-DO List
  • Known bugs
  • Changelog
  • License
  • Authors
• References
  • Sphinx documentation
  • reStructuredText documentation