6. Help Documenting OpenMDAO

• 6.1. Updating OpenMDAO Documents
  • 6.1.1. Updating an Existing Document
  • 6.1.2. Creating a New Document
  • 6.1.3. Building and Displaying Documents
• 6.2. Sphinx and reStructuredText
  • 6.2.1. Some Basics
  • 6.2.2. Literal Text
  • 6.2.3. Hyperlinks
  • 6.2.4. Figures
  • 6.2.5. Add Lines/Maintain Line Break
  • 6.2.6. Lists/Bullets
  • 6.2.7. Tables
  • 6.2.8. Index Items
  • 6.2.9. Testing Code
  • 6.2.10. Code from the Source
• 6.3. Style Guide
  • 6.3.1. Standard for Coding Docstrings
  • 6.3.2. Underlines (and Overlines)
  • 6.3.3. Italics
  • 6.3.4. Capitalization
  • 6.3.5. Numbers
  • 6.3.6. Inline Literal Text
  • 6.3.7. Abbreviations and Acronyms
  • 6.3.8. Hyphens and Dashes
  • 6.3.9. Comma (in a Compound Sentence)
  • 6.3.10. Login vs Log in