# sphinx-markdown-builder
[](https://coveralls.io/github/liran-funaro/sphinx-markdown-builder?branch=main)
A Sphinx extension to add markdown generation support.
## Install
```sh
pip3 install sphinx-markdown-builder==0.6.8
```
## Usage
Add the extension to your `conf.py` file:
```python
extensions = [
...,
"sphinx_markdown_builder",
...,
]
```
Build markdown files with `sphinx-build` command
```sh
sphinx-build -M markdown ./docs ./build
```
## Configurations
You can add the following configurations to your `conf.py` file:
* `markdown_anchor_sections`/`markdown_anchor_signatures`: If set to `True`,
then anchors will be added before each section/function/class signature.
This allows references to a specific anchor in the document.
* `markdown_docinfo`: Adds metadata to the top of each document containing author, copyright, and version.
* `markdown_http_base`: If set, all references will link to this prefix address
* `markdown_uri_doc_suffix`: If set, all references will link to documents with this suffix.
* `markdown_bullet`: Sets the bullet marker.
For example, if your `conf.py` file have the following configuration:
```python
markdown_http_base = "https://your-domain.com/docs"
markdown_uri_doc_suffix = ".html"
markdown_bullet = "*"
```
Then a reference to `your-doc-name#your-header` will be substituted with `https://your-domain.com/docs/your-doc-name.html#your-header`.
## Contributing
See the [code contribution guidelines](CONTRIBUTING.md) for more information.
## Credits
This project forked from [clayrisser/sphinx-markdown-builder], which was developed by [Clay Risser] under the [MIT] license.
The original implementation was based on [doctree2md] by [Matthew Brett] under the [BSD-2] license.
## License
[MIT]
[clayrisser/sphinx-markdown-builder]: https://github.com/clayrisser/sphinx-markdown-builder
[Clay Risser]: https://github.com/clayrisser
[doctree2md]: https://github.com/matthew-brett/nb2plots/blob/master/nb2plots/doctree2md.py
[Matthew Brett]: https://github.com/matthew-brett
[MIT]: LICENSE
[BSD-2]: https://github.com/matthew-brett/nb2plots/blob/main/LICENSE
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-markdown-builder",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "sphinx, sphinx-extension, markdown, docs, documentation, builder",
"author": null,
"author_email": "Liran Funaro <liran.funaro@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/74/36/f4a2efb804e2b89a6a29338bd1e9895af806e465c4a13ca59271f9d40dfd/sphinx_markdown_builder-0.6.8.tar.gz",
"platform": null,
"description": "# sphinx-markdown-builder\n\n[](https://coveralls.io/github/liran-funaro/sphinx-markdown-builder?branch=main)\n\nA Sphinx extension to add markdown generation support.\n\n## Install\n\n```sh\npip3 install sphinx-markdown-builder==0.6.8\n```\n\n## Usage\n\nAdd the extension to your `conf.py` file:\n```python\nextensions = [\n ...,\n \"sphinx_markdown_builder\",\n ...,\n]\n```\n\nBuild markdown files with `sphinx-build` command\n```sh\nsphinx-build -M markdown ./docs ./build\n```\n\n## Configurations\n\nYou can add the following configurations to your `conf.py` file:\n\n* `markdown_anchor_sections`/`markdown_anchor_signatures`: If set to `True`, \n then anchors will be added before each section/function/class signature. \n This allows references to a specific anchor in the document.\n* `markdown_docinfo`: Adds metadata to the top of each document containing author, copyright, and version.\n* `markdown_http_base`: If set, all references will link to this prefix address\n* `markdown_uri_doc_suffix`: If set, all references will link to documents with this suffix.\n* `markdown_bullet`: Sets the bullet marker.\n\nFor example, if your `conf.py` file have the following configuration:\n\n```python\nmarkdown_http_base = \"https://your-domain.com/docs\"\nmarkdown_uri_doc_suffix = \".html\"\nmarkdown_bullet = \"*\"\n```\n\nThen a reference to `your-doc-name#your-header` will be substituted with `https://your-domain.com/docs/your-doc-name.html#your-header`. \n\n\n## Contributing\n\nSee the [code contribution guidelines](CONTRIBUTING.md) for more information.\n\n## Credits\nThis project forked from [clayrisser/sphinx-markdown-builder], which was developed by [Clay Risser] under the [MIT] license.\n\nThe original implementation was based on [doctree2md] by [Matthew Brett] under the [BSD-2] license.\n\n## License\n\n[MIT]\n\n[clayrisser/sphinx-markdown-builder]: https://github.com/clayrisser/sphinx-markdown-builder\n[Clay Risser]: https://github.com/clayrisser\n[doctree2md]: https://github.com/matthew-brett/nb2plots/blob/master/nb2plots/doctree2md.py\n[Matthew Brett]: https://github.com/matthew-brett\n[MIT]: LICENSE\n[BSD-2]: https://github.com/matthew-brett/nb2plots/blob/main/LICENSE\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Sphinx extension to add markdown generation support.",
"version": "0.6.8",
"project_urls": {
"Homepage": "https://github.com/liran-funaro/sphinx-markdown-builder"
},
"split_keywords": [
"sphinx",
" sphinx-extension",
" markdown",
" docs",
" documentation",
" builder"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31987e8e11d4edce0947d89c5d00ed43d925a5254dc9733579382b04f77e5ff2",
"md5": "9456345cb8008d8cba4221594c8706b6",
"sha256": "f04ab42d52449363228b9104569c56b778534f9c41a168af8cfc721a1e0e3edc"
},
"downloads": -1,
"filename": "sphinx_markdown_builder-0.6.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9456345cb8008d8cba4221594c8706b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 17270,
"upload_time": "2025-01-19T01:58:19",
"upload_time_iso_8601": "2025-01-19T01:58:19.296393Z",
"url": "https://files.pythonhosted.org/packages/31/98/7e8e11d4edce0947d89c5d00ed43d925a5254dc9733579382b04f77e5ff2/sphinx_markdown_builder-0.6.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7436f4a2efb804e2b89a6a29338bd1e9895af806e465c4a13ca59271f9d40dfd",
"md5": "0143713e0c6dfbe9d0961cbf10b44d6b",
"sha256": "6141b566bf18dd1cd515a0a90efd91c6c4d10fc638554fab2fd19cba66543dd7"
},
"downloads": -1,
"filename": "sphinx_markdown_builder-0.6.8.tar.gz",
"has_sig": false,
"md5_digest": "0143713e0c6dfbe9d0961cbf10b44d6b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 22007,
"upload_time": "2025-01-19T01:58:20",
"upload_time_iso_8601": "2025-01-19T01:58:20.497833Z",
"url": "https://files.pythonhosted.org/packages/74/36/f4a2efb804e2b89a6a29338bd1e9895af806e465c4a13ca59271f9d40dfd/sphinx_markdown_builder-0.6.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-19 01:58:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "liran-funaro",
"github_project": "sphinx-markdown-builder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-markdown-builder"
}
JSON
