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 | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cylc-sphinx-extensions-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73030223e1c2b81463140cde4e3c2ba5d6c2211ee5f6a1d7dd06a42ec11a4817 |
|
MD5 | deb6c9184093cb4c46c10028fc571718 |
|
BLAKE2b-256 | ab8276f9f568091627d2965252b9b09f57427b129b9d94e97116891875781786 |
Hashes for cylc_sphinx_extensions-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15d25c57df5516d1d4c03b693a9344b656087eda6d7f513f9d0dbfa3df81369b |
|
MD5 | c28070327d1621f22c4ba4037c5484dc |
|
BLAKE2b-256 | 18f4caa3f80e99eb2200983532432c4349f865cb575bbbaa84d04f1ccc35ddc7 |