Sphinx: Waterloo Docstrings documentation

Contents:

• 1. Introduction
  • 1.1. What This Extension Does
  • 1.2. Why Waterloo Docstrings
  • 1.3. Design Goals
  • 1.4. What This Extension Is Not
  • 1.5. How It Fits Into Waterloo
  • 1.6. Project Status
  • 1.7. Dependencies
• 2. Getting Started
  • 2.1. Choose The Directories
  • 2.2. Create A Virtual Environment
  • 2.3. Install The Extension
  • 2.4. Create A Sphinx Project
  • 2.5. Enable Waterloo In Sphinx
  • 2.6. Add A Waterloo Docstring
  • 2.7. Render The Docstring
  • 2.8. Optional Theme Notes
• 3. Configuration
  • 3.1. Diagnostics
  • 3.2. State And Scope
  • 3.3. Import Resolution
  • 3.4. Sphinx Setup Hook
• 4. Directives
  • 4.1. Docstring Rendering Directives
  • 4.2. State-Changing Directives
    • 4.2.1. Module And Class Stack
    • 4.2.2. Scope Stack
  • 4.3. Callable Signature Directives
• 5. Roles
  • 5.1. Semantic Markup
  • 5.2. Normativity and value tokens
  • 5.3. Cross referencing
• 6. CSS Customization
  • 6.1. Tested Themes
  • 6.2. common_styles.css
    • 6.2.1. Recommended Customization Pattern
  • 6.3. waterloo_base.css
    • 6.3.1. Custom Admonitions
    • 6.3.2. Multiline Signatures
    • 6.3.3. Normative Keywords
    • 6.3.4. Out Of Scope
    • 6.3.5. Unresolved Links
• 7. Miscellaneous
  • 7.1. Escaping
  • 7.2. Itemization
• 8. Admonitions
  • 8.1. Error Admonitions
    • 8.1.1. Inappropriate Directive
    • 8.1.2. Pop On Empty Stack
    • 8.1.3. Push/Pop Mismatch
    • 8.1.4. Non-Existing Object
    • 8.1.5. Missing Docstring
    • 8.1.6. Empty Docstring
    • 8.1.7. Not A Waterloo Docstring
    • 8.1.8. Parsing Or Validation Error
  • 8.2. Info Admonitions
    • 8.2.1. Out Of Scope
  • 8.3. State-Change Admonitions
• 9. Reference
  • 9.1. Module extension
    • 9.1.1. Helper
      • 9.1.1.1. Function resolve_qualified_name
      • 9.1.1.2. Function resolve_markup
      • 9.1.1.3. Function build_sphinx_nodes
      • 9.1.1.4. Function build_sphinx_nodes_full
      • 9.1.1.5. Function parse_inline
      • 9.1.1.6. Class context
    • 9.1.2. Directives for docstring rendering
    • 9.1.3. Directives for controlling the state stack
      • 9.1.3.1. Scope stack
      • 9.1.3.2. Module stack
      • 9.1.3.3. Class stack
    • 9.1.4. Directives for rendering signatures
      • 9.1.4.1. Function wtrl_build_method_signature_nodes
      • 9.1.4.2. Function wtrl_build_function_signature_nodes
      • 9.1.4.3. Function wtrl_build_method_signature_block_nodes
      • 9.1.4.4. Function wtrl_build_function_signature_block_nodes
    • 9.1.5. Roles for semantic markup
      • 9.1.5.1. Helper classes
      • 9.1.5.2. Function wtrl_attr_role
      • 9.1.5.3. Similar roles
      • 9.1.5.4. Function wtrl_var_type_role