Skip to main content

Sphinx extensions for documenting Cylc

Project description

A library of extensions for documenting Cylc projects.

Installation

Install all extensions (but not dependencies):

$ pip install cylc-sphinx-extensions

OR all extensions + dependencies for specified extension(s) by name:

$ pip install cylc-sphinx-extensions.git[cylc_lang]

OR all extensions + dependencies for all extensions:

$ pip install cylc-sphinx-extensions.git[all]

Note the minicylc extension requires graphviz:

.. code-block:: console
# install graphviz from your package manager e.g: $ sudo apt-get install -y graphviz

Usage

To use an extension register it in your project’s conf.py:

extension = [
    'cylc.sphinx_ext.cylc_lang'
]

Some of these extensions are “auto-loading” and do not require any extra steps to activate.

If the html_static_path configuration is set in your conf.py you will need to move this into a setup function, otherwise extensions cannot append to this path to add their own static resources e.g:

def setup(app):
    app.config.html_static_path.append('_static')

Development

Fork and clone https://github.com/cylc/cylc-sphinx-extensions.git.

Extensions are auto-documented from their module docstrings.

Build documentation by running:

$ make clean <format>  # e.g. make html

This documentation build serves as a simple test battery (warnings will cause it to fail), for everything else there’s pytest:

$ pytest

For code linting:

$ pycodestyle .  # python
$ eslint cylc/   # javascript

Project details


Release history Release notifications

Download files

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

Files for cylc-sphinx-extensions, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size cylc_sphinx_extensions-1.0.0-py3-none-any.whl (44.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cylc-sphinx-extensions-1.0.0.tar.gz (18.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page