docusaurus
Class CustomizedMarkdownRenderer
@dataclasses.dataclass
class CustomizedMarkdownRenderer(MarkdownRenderer)
We override some defaults in this subclass.
insert_header_anchors
Disabled because Docusaurus supports this automatically.
escape_html_in_docstring
Escape html in docstring, otherwise it could lead to invalid html.
render_module_header_template
Conforms to Docusaurus header format.
Class DocusaurusRenderer
@dataclasses.dataclass
class DocusaurusRenderer(Renderer)
Produces Markdown files and a sidebar.json file for use in a Docusaurus v2 websites.
It creates files in a fixed layout that reflects the structure of the documented packages.
The files will be rendered into the directory specified with the docs_base_path option.
Check out the complete Docusaurus example on GitHub.
Options
markdown
The MarkdownRenderer configuration.
docs_base_path
The path where the docusaurus docs content is. Defaults "docs" folder.
relative_output_path
The output path inside the docs_base_path folder, used to output the module reference.
relative_sidebar_path
The sidebar path inside the docs_base_path folder, used to output the sidebar for the module reference.
sidebar_top_level_label
The top-level label in the sidebar. Default to 'Reference'. Can be set to null to remove the sidebar top-level all together. This option assumes that there is only one top-level module.
sidebar_top_level_module_label
The top-level module label in the sidebar. Default to null, meaning that the actual module name will be used. This option assumes that there is only one top-level module.