Skip to content

Commit

Permalink
Activate sphinx-needs extension in doc config.
Browse files Browse the repository at this point in the history
The docs have lots of sphinx needs directives in them, including
implementation (.. impl::) and tests (.. test::). These are defined by
the sphinx-needs extension, which is in our requirements but not
actually activated in our docs config. This activates it in the docs.
The net result is that hundreds of errors in the doc build process are
resolved.
  • Loading branch information
ntouran committed Jan 30, 2024
1 parent 0668e8c commit 6d9ebd9
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ def setup(app):
"sphinxcontrib.plantuml",
"sphinx_rtd_theme", # needed here for loading jquery in sphinx 6
"sphinxcontrib.jquery", # see https://github.com/readthedocs/sphinx_rtd_theme/issues/1452
"sphinx_needs",
]

# Our API should make sense without documenting private/special members.
Expand Down

0 comments on commit 6d9ebd9

Please sign in to comment.