# sphinx-scylladb-markdown
The Sphinx ScyllaDB Markdown Extension is specifically designed for projects using [sphinx-multiversion](https://github.com/Holzhaus/sphinx-multiversion). It facilitates a smooth transition from recommonmark to MystParser in Sphinx documentation.
This extension is particularly useful in scenarios where older documentation versions require recommonmark, which is now [deprecated](https://recommonmark.readthedocs.io/en/latest/), while newer versions can leverage the advanced features of MystParser.
## Installation
To install the Sphinx ScyllaDB Markdown Extension, follow these steps:
1. Run the following command within your Sphinx project directory:
```bash
pip install sphinx-scylladb-markdown
```
1. Add the following lines to your ``conf.py`` file in your Sphinx project:
```bash
extensions = [
...
'sphinx_scylladb_markdown',
...
]
```
1. Set the ``scylladb_markdown_enable`` in your ``conf.py``:
```python
scylladb_markdown_enable = True
```
1. Optional: If you want to use recommonmark for specific versions, list them in ``scylladb_markdown_recommonmark_versions`` in your `conf.py` file:
```python
scylladb_markdown_recommonmark_versions = ['v1.0', 'v1.1']
```
## License
Copyright (c) 2023-present ScyllaDB Licensed under the `Apache License 2.0 <LICENSE>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/scylladb/sphinx-scylladb-theme",
"name": "sphinx-scylladb-markdown",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "David Garcia",
"author_email": "hi@davidgarcia.dev",
"download_url": "",
"platform": null,
"description": "# sphinx-scylladb-markdown\n\nThe Sphinx ScyllaDB Markdown Extension is specifically designed for projects using [sphinx-multiversion](https://github.com/Holzhaus/sphinx-multiversion). It facilitates a smooth transition from recommonmark to MystParser in Sphinx documentation. \n\nThis extension is particularly useful in scenarios where older documentation versions require recommonmark, which is now [deprecated](https://recommonmark.readthedocs.io/en/latest/), while newer versions can leverage the advanced features of MystParser.\n\n## Installation\n\nTo install the Sphinx ScyllaDB Markdown Extension, follow these steps:\n\n1. Run the following command within your Sphinx project directory:\n\n ```bash\n pip install sphinx-scylladb-markdown\n ```\n\n1. Add the following lines to your ``conf.py`` file in your Sphinx project:\n\n ```bash\n extensions = [\n ...\n 'sphinx_scylladb_markdown',\n ...\n ]\n ```\n\n1. Set the ``scylladb_markdown_enable`` in your ``conf.py``:\n\n ```python\n scylladb_markdown_enable = True\n ```\n\n1. Optional: If you want to use recommonmark for specific versions, list them in ``scylladb_markdown_recommonmark_versions`` in your `conf.py` file:\n\n ```python\n scylladb_markdown_recommonmark_versions = ['v1.0', 'v1.1']\n ```\n\n## License\n\nCopyright (c) 2023-present ScyllaDB Licensed under the `Apache License 2.0 <LICENSE>`_.\n",
"bugtrack_url": null,
"license": "",
"summary": "Sphinx extension for ScyllaDB documentation with enhanced Markdown support through MystParser and recommonmark.",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/scylladb/sphinx-scylladb-theme"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b08a475e339b4646a3491df0fa9df0ae86d7ae7b1ccf72d5f54be9c6c295c8e",
"md5": "0fc4747763e5c6e51d06700cb280a3b7",
"sha256": "f20160b4aadf4c8cf95637f0a544121954b792914ab6ec05b67cae75e20a5566"
},
"downloads": -1,
"filename": "sphinx_scylladb_markdown-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0fc4747763e5c6e51d06700cb280a3b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7763,
"upload_time": "2023-12-26T10:41:42",
"upload_time_iso_8601": "2023-12-26T10:41:42.519149Z",
"url": "https://files.pythonhosted.org/packages/8b/08/a475e339b4646a3491df0fa9df0ae86d7ae7b1ccf72d5f54be9c6c295c8e/sphinx_scylladb_markdown-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-26 10:41:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scylladb",
"github_project": "sphinx-scylladb-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-scylladb-markdown"
}
JSON
