doc/common/extensions: Hide version directives in IDE build.

Version tags can be useful to keep track of new or updated features.

This lets us hide such details in the documentation that ships with the IDE to keep it concise.
This commit is contained in:
Laurens Valk
2022-04-01 09:38:41 +02:00
parent 1989561c90
commit 93a9370790
2 changed files with 30 additions and 0 deletions
+2
View File
@@ -53,10 +53,12 @@ extensions = [
'sphinx.ext.napoleon',
'sphinx.ext.todo',
'sphinx.ext.mathjax',
# Custom Pybricks extensions
'color',
'classlink',
'requirements',
'requirements-static',
'versionchanged',
]
# Add any paths that contain templates here, relative to this directory.
+28
View File
@@ -0,0 +1,28 @@
"""This directive hides the builtin directives
* versionchanged
* versionadded
* deprecated
when building documentation with the 'ide' tag.
"""
from docutils import nodes
from docutils.parsers.rst import Directive
class PybricksVersionDirective(Directive):
has_content = True
def run(self):
html = ""
node = nodes.raw('', html, format="html")
return [node]
def setup(app):
if 'ide' in app.tags.tags:
app.add_directive_to_domain('py', 'deprecated',
PybricksVersionDirective, override=True)
app.add_directive_to_domain('py', 'versionadded',
PybricksVersionDirective, override=True)
app.add_directive_to_domain('py', 'versionchanged',
PybricksVersionDirective, override=True)