Skip to main content
Ctrl+K
⚠️ This extension is still in early development. If you have ideas on what could be improved, let me know! ⚠️

PeakRDL Extension for Sphinx-Doc

  • Introduction
  • Cross-references
  • Inline Documentation
  • Configuring

Examples

  • Using Cross-references
  • Using the docnode directive
  • Using the doctree directive
  • Repository
  • Open issue

Index

C | L | N | P | R | W

C

  • configuration value
    • peakrdl_cfg_toml
    • peakrdl_default_link_to
    • peakrdl_defines
    • peakrdl_doc_wrap_section
    • peakrdl_html_enable
    • peakrdl_html_extra_doc_properties
    • peakrdl_html_title
    • peakrdl_incdirs
    • peakrdl_input_files
    • peakrdl_parameters
    • peakrdl_top_component

L

  • :link-to:: (directive option)
    • rdl:docnode (directive)
    • rdl:doctree (directive)

N

  • :no-wrap-section:: (directive option)
    • rdl:docnode (directive)

P

  • peakrdl_cfg_toml
    • configuration value
  • peakrdl_default_link_to
    • configuration value
  • peakrdl_defines
    • configuration value
  • peakrdl_doc_wrap_section
    • configuration value
  • peakrdl_html_enable
    • configuration value
  • peakrdl_html_extra_doc_properties
    • configuration value
  • peakrdl_html_title
    • configuration value
  • peakrdl_incdirs
    • configuration value
  • peakrdl_input_files
    • configuration value
  • peakrdl_parameters
    • configuration value
  • peakrdl_top_component
    • configuration value

R

  • rdl:doc-ref (role)
  • rdl:docnode (directive)
    • :link-to:: (directive option)
    • :no-wrap-section:: (directive option)
    • :wrap-section:: (directive option)
  • rdl:doctree (directive)
    • :link-to:: (directive option)
  • rdl:html-ref (role)
  • rdl:ref (role)
  • rdl:relative-to (directive)

W

  • :wrap-section:: (directive option)
    • rdl:docnode (directive)

By Alex Mykyta

© Copyright 2026, Alex Mykyta.