sphinx-markdown-builder


Namesphinx-markdown-builder JSON
Version 0.6.5 PyPI version JSON
download
home_page
SummaryA Sphinx extension to add markdown generation support.
upload_time2023-08-13 05:31:33
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT
keywords sphinx sphinx-extention markdown docs documentation builder
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # sphinx-markdown-builder

[![Coverage Status](https://coveralls.io/repos/github/liran-funaro/sphinx-markdown-builder/badge.svg?branch=main)](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.5
```

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

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

Then a reference to `your-doc-name#your-header` will be substituted with `https://your-domain.com/docs/your-doc-name.html#your-header`. 

## 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": "",
    "name": "sphinx-markdown-builder",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "sphinx,sphinx-extention,markdown,docs,documentation,builder",
    "author": "",
    "author_email": "Liran Funaro <liran.funaro@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/45/a7/2bfcf4d8ad4886cc769b89a417c7b458ff6a7a69ffbeb71a93dbc5e65e88/sphinx-markdown-builder-0.6.5.tar.gz",
    "platform": null,
    "description": "# sphinx-markdown-builder\n\n[![Coverage Status](https://coveralls.io/repos/github/liran-funaro/sphinx-markdown-builder/badge.svg?branch=main)](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.5\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\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\"\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## 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.5",
    "project_urls": {
        "Homepage": "https://github.com/liran-funaro/sphinx-markdown-builder"
    },
    "split_keywords": [
        "sphinx",
        "sphinx-extention",
        "markdown",
        "docs",
        "documentation",
        "builder"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "88d27f3f7d9446c2dd724df7719a6347f234448111d331149926ae6e111cf0ec",
                "md5": "3b81a66a933342d197624a64ec919b64",
                "sha256": "59c8e841b56bbf04a2c11e1984f7258fa28a20c0257aa54ea3ae7a0013a27d4a"
            },
            "downloads": -1,
            "filename": "sphinx_markdown_builder-0.6.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3b81a66a933342d197624a64ec919b64",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 16021,
            "upload_time": "2023-08-13T05:31:31",
            "upload_time_iso_8601": "2023-08-13T05:31:31.883319Z",
            "url": "https://files.pythonhosted.org/packages/88/d2/7f3f7d9446c2dd724df7719a6347f234448111d331149926ae6e111cf0ec/sphinx_markdown_builder-0.6.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "45a72bfcf4d8ad4886cc769b89a417c7b458ff6a7a69ffbeb71a93dbc5e65e88",
                "md5": "9609f463d64ccd1cf3e4de022886101b",
                "sha256": "dae3184cfefdfe9ee1af69ae9e6e09cf2768f51afeb81ae1b3c219dbfdb33e97"
            },
            "downloads": -1,
            "filename": "sphinx-markdown-builder-0.6.5.tar.gz",
            "has_sig": false,
            "md5_digest": "9609f463d64ccd1cf3e4de022886101b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 20407,
            "upload_time": "2023-08-13T05:31:33",
            "upload_time_iso_8601": "2023-08-13T05:31:33.789870Z",
            "url": "https://files.pythonhosted.org/packages/45/a7/2bfcf4d8ad4886cc769b89a417c7b458ff6a7a69ffbeb71a93dbc5e65e88/sphinx-markdown-builder-0.6.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-13 05:31:33",
    "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"
}
Elapsed time: 0.12446s