Metadata-Version: 2.1
Name: sphinx-scylladb-markdown
Version: 0.1.3
Summary: Sphinx extension for ScyllaDB documentation with enhanced Markdown support through MystParser and recommonmark.
Home-page: https://github.com/scylladb/sphinx-scylladb-theme
Author: David Garcia
Author-email: hi@davidgarcia.dev
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx >=2.1
Requires-Dist: recommonmark ==0.7.1
Requires-Dist: sphinx-markdown-tables ==0.0.17
Requires-Dist: myst-parser >=2.0.0

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