Sphinx

This chapter is about installing sphinx, my preferred theme sphinx-book-theme and code snippets for daily use to create and style content.

Sections	Description
Install	Step-by-step instructions for installing Sphinx and the preferred theme, Sphinx Book Theme.
Content and Formatting	Contains excerpts from frequently used syntax for styling documentation.

• Installation
  • Basic Installation
    • Prerequisites
  • Theme Installation
    • install packages
    • MyST
    • Sphinx-Design
    • Mermaid Diagramming
    • Sphinx Copybutton
    • config files
      • conf.py
      • ‘requirements.txt’
• Content and formatting
  • Admonitions
    • Admonition types
      • Topics
      • Container
    • Other Containers
      • Card
      • Tab-Set
  • Special Content blocks
    • Quotations and epigraphs
      • Default markdown quotes
      • Epigraph with attribution
      • Text with footnote on side
  • CSS classes for custom margin content
    • Margin Note
    • Content examples in the margin
    • Full-width content
    • Sidebars
  • Data Elements
    • Code blocks
  • Lists and Tables
    • Table
    • Enumerated Lists