sphinx-markdown-builder
sphinx-markdown-builder copied to clipboard
liran-funaro
A Sphinx extension to add markdown generation support.
**Describe the bug** markdown_uri_doc_suffix and markdown_file_suffix ignored **To Reproduce** Steps to reproduce the behavior: **Filename: docs/conf.py** ```python extensions = [ ..., "sphinx_markdown_builder", ] # -- Options for sphinx-markdown-builder ------------------------------------- #...
Similar to the `singlehtml` built-in builder in Sphinx, the `singlemarkdown` builder collects all documentation pages together in a single `.md` file. This is useful e.g. for providing documentation of a...
**Is your feature request related to a problem? Please describe.** VS code previews, and I assume many other apps, see most links as broken. **Describe the solution you'd like** An...
# **Describe the Bug** When using **Sphinx** with the **Napoleon** extension and **Markdown builder**, type annotations in Google-style docstrings that include square brackets (e.g., `Optional[str]`, `(Optional [Mapping [str , Any...
**Describe the bug** A clear and concise description of what the bug is. When documenting functions with multiple @overload signatures, the * symbol in the rendered md files are omitted...
**Is your feature request related to a problem? Please describe.** The generated markdown uses a base of three levels for sub-headers: ``` # AirtopWindowScreenshot ### *class* airtop_sdk.AirtopWindowScreenshot(screenshot_data: Dict[str, Any]) ```...
**Describe the discrepancy** Image asset paths are incorrectly translated to a path relative to the Sphinx root instead of relative to the document the reference occurs in. This is because...
Ran into some complications when trying to use this builder for a document set that was previously hosted in html. Mostly this was to do with directives generated by the...
**Describe the discrepancy** Some parts of autodoc are not properly displayed in markdown. The only functionality I tested was code blocks and images, but it could be other things as...
**Describe the discrepancy** A clear and concise description of the discrepancy. The markdown file that is generated from a given .rst file does not work for me. For example, in...
Metadata
Owner
Metadata
A Sphinx extension to add markdown generation support.