sphinx-systemverilog

A Sphinx autodoc extension for SystemVerilog, powered by the pyslang parser.

It documents SystemVerilog source the way sphinx.ext.autodoc documents Python: declarations and their doc comments are pulled directly from source. Multiple comment dialects are supported — a Python-docstring-like native style today, with NaturalDocs and Doxygen on the roadmap.

Usage

• Getting started
  • Install
  • Enable the extension
  • Document something
  • Configuration reference
• Directives & roles
  • Autodoc directives
  • Manual domain directives
  • Cross-reference roles
• The native comment style
  • Rules
  • Example
  • Cross-references inside comments
• The NaturalDocs comment style
  • Documentation blocks
  • Inline markup
  • Detached blocks and groups
• The Doxygen comment style
  • Supported commands
  • Inline markup
  • Example
• Documenting modules & interfaces
  • Parameters and ports
• Inheritance diagrams
  • Prerequisite
  • Usage
• Whole-tree documentation
  • Basic use
  • Narrowing the scope
• Cross-referencing, source links & intersphinx
  • Roles
  • Source links (viewcode)
  • Intersphinx
• Advanced constructs & performance
  • Macros
  • Covergroups & constraints
  • Structural instance diagrams
  • Performance

Examples

• Example: the sample package
• Example: NaturalDocs, modules & diagrams
• Example: documenting UVM

Status

Phases 1 and 2 are implemented: the native and naturaldocs dialects, classes/packages/modules (with ports & parameters), the core domain + autodoc machinery, inheritance diagrams, and dialect auto-detection. See the design and implementation plan under docs/design/ in the repository.

Indices

• Index

• Search Page