Sphinx

Sphinx is a tool to generate documentation for software projects and was originally developed to document the Python programming language. My intention is to use Sphinx to document a variety of different topics and in the creation of a “static” web-site.

• First Steps
  • Installation
  • Creating a Project
  • Adding Content
  • References
• Render Maths as Images
  • Step 1: Install LaTeX
  • Step 2: Sphinx extension
  • Step 3: Add Maths notation
  • Other Samples
  • Alternatives
    • On-line converters
    • mimeTeX mathTeX
• Sample rst syntax
  • Appendix
    • Special Characters
    • Supported Code Languages
• Generate PDF Files
  • LaTeX stack
  • Convert LaTeX files to a PDF file
• Hints and Tips
  • Upgrade sphinx and theme
  • Enable strikethrough text
  • Open Image File on Click
• Links
  • The Sphinx Thesis Resource

Projects

• Projects
  • SWwiki
  • Journals