mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-11 17:14:41 +00:00
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:
@@ -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.
|
||||
|
||||
@@ -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)
|
||||
Reference in New Issue
Block a user