sphinx-scylladb-markdown 0.1.0

Sphinx extension for ScyllaDB documentation with enhanced Markdown support through MystParser and recommonmark.

sphinx-scylladb-markdown

The Sphinx ScyllaDB Markdown Extension is specifically designed for projects using 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, 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:

   pip install sphinx-scylladb-markdown
   

2. Add the following lines to your conf.py file in your Sphinx project:

   extensions = [
       ...
       'sphinx_scylladb_markdown',
       ...
   ]
   

3. Set the scylladb_markdown_enable in your conf.py:

   scylladb_markdown_enable = True
   

4. Optional: If you want to use recommonmark for specific versions, list them in scylladb_markdown_recommonmark_versions in your conf.py file:

   scylladb_markdown_recommonmark_versions = ['v1.0', 'v1.1']
   

License

Copyright (c) 2023-present ScyllaDB Licensed under the Apache License 2.0 <LICENSE>_.