Skip to main content

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

Project description

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

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

sphinx_scylladb_markdown-0.1.3-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_scylladb_markdown-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_scylladb_markdown-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f20160b4aadf4c8cf95637f0a544121954b792914ab6ec05b67cae75e20a5566
MD5 0fc4747763e5c6e51d06700cb280a3b7
BLAKE2b-256 8b08a475e339b4646a3491df0fa9df0ae86d7ae7b1ccf72d5f54be9c6c295c8e

See more details on using hashes here.

Supported by

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