docs: dynamic include based on flag
docs: extend include options Closes scylladb/scylladb#16753
This commit is contained in:
committed by
Botond Dénes
parent
af0772d605
commit
f555a2cb05
25
docs/_ext/scylladb_include_flag.py
Normal file
25
docs/_ext/scylladb_include_flag.py
Normal file
@@ -0,0 +1,25 @@
|
||||
from sphinx.directives.other import Include
|
||||
from docutils.parsers.rst import directives
|
||||
|
||||
class IncludeFlagDirective(Include):
|
||||
option_spec = Include.option_spec.copy()
|
||||
option_spec['base_path'] = directives.unchanged
|
||||
|
||||
def run(self):
|
||||
env = self.state.document.settings.env
|
||||
base_path = self.options.get('base_path', '_common')
|
||||
|
||||
if env.app.tags.has('enterprise'):
|
||||
self.arguments[0] = base_path + "_enterprise/" + self.arguments[0]
|
||||
else:
|
||||
self.arguments[0] = base_path + "/" + self.arguments[0]
|
||||
return super().run()
|
||||
|
||||
def setup(app):
|
||||
app.add_directive('scylladb_include_flag', IncludeFlagDirective, override=True)
|
||||
|
||||
return {
|
||||
"version": "0.1",
|
||||
"parallel_read_safe": True,
|
||||
"parallel_write_safe": True,
|
||||
}
|
||||
@@ -39,7 +39,8 @@ extensions = [
|
||||
"sphinx_scylladb_markdown",
|
||||
"sphinxcontrib.datatemplates",
|
||||
"scylladb_cc_properties",
|
||||
"scylladb_aws_images"
|
||||
"scylladb_aws_images",
|
||||
"scylladb_include_flag"
|
||||
]
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
|
||||
Reference in New Issue
Block a user