Skip to main content

A Sphinx extension to add markdown generation support.

Project description

sphinx-markdown-builder

Coverage Status

A Sphinx extension to add markdown generation support.

Install

pip3 install sphinx-markdown-builder==0.6.8

Usage

Add the extension to your conf.py file:

extensions = [
    ...,
    "sphinx_markdown_builder",
    ...,
]

Build markdown files with sphinx-build command

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:

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 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_markdown_builder-0.6.8.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

sphinx_markdown_builder-0.6.8-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_markdown_builder-0.6.8.tar.gz.

File metadata

  • Download URL: sphinx_markdown_builder-0.6.8.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for sphinx_markdown_builder-0.6.8.tar.gz
Algorithm Hash digest
SHA256 6141b566bf18dd1cd515a0a90efd91c6c4d10fc638554fab2fd19cba66543dd7
MD5 0143713e0c6dfbe9d0961cbf10b44d6b
BLAKE2b-256 7436f4a2efb804e2b89a6a29338bd1e9895af806e465c4a13ca59271f9d40dfd

See more details on using hashes here.

File details

Details for the file sphinx_markdown_builder-0.6.8-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_markdown_builder-0.6.8-py3-none-any.whl
Algorithm Hash digest
SHA256 f04ab42d52449363228b9104569c56b778534f9c41a168af8cfc721a1e0e3edc
MD5 9456345cb8008d8cba4221594c8706b6
BLAKE2b-256 31987e8e11d4edce0947d89c5d00ed43d925a5254dc9733579382b04f77e5ff2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page