1. Concepts

Section author:

Let’s document the project. A lot of these reStructuredText syntax examples are covered in the Sphinx reStructuredText Primer. The outline for this chapter has been taken from Documenting Python and adapted and extended for our needs.

List of Concepts

• 1.1. Use of whitespace
• 1.2. Sphinx naming
  • 1.2.1. Roles
  • 1.2.2. Directives
  • 1.2.3. Domains
• 1.3. Parts, Chapters, Titles, Sections
• 1.4. Table of Contents Tree
• 1.5. Paragraphs
• 1.6. Inline Markup
• 1.7. File, Directory, Path
• 1.8. Lists, Definition Lists
• 1.9. Explicit Markup
• 1.10. Reuse Content
  • 1.10.1. Include a Shared File
  • 1.10.2. Substitutions
• 1.11. Images and Figures
• 1.12. Tables
• 1.13. Code Example
• 1.14. Mathematics
• 1.15. Admonitions
• 1.16. Hyperlink
• 1.17. Referencing
• 1.18. External References
• 1.19. Downloadable Files
• 1.20. Semantic Descriptions and References
• 1.21. Writing about User Interface
• 1.22. Glossary
• 1.23. Index