Users

• Terminology
  • reStructuredText (.rst)
  • Sphinx extension
  • Role
  • Sphinx directive
    • Optional parameters
    • Configuration
• Usage in a .rst file
• Configuration
  • Optional parameters
  • conf.py
    • sphinx-uml specific options
    • Environment
  • sphinx-uml inherited options
• Examples
  • Classes diagram
  • Packages diagram
  • Both
• Using sphinx-uml in auto-generated documentation
  • Extensions (docs/conf.py)
  • Templates
  • Building the documentation
• Troubleshooting