Sphinx extensions for documenting Cylc
Project description
A library of Sphinx 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:
# 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 e.g:
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 slides
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
Copyright and Terms of Use
Copyright (C) 2008-2021 NIWA & British Crown (Met Office) & Contributors.
Cylc is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Cylc is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Cylc. If not, see GNU licenses http://www.gnu.org/licenses/.
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.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d00ce148b6ac57b11a9e3824a0b8abd424b9b40577c739e7af8e00735458b087 |
|
MD5 | 1660c558bd02e7d09389554dc14f8766 |
|
BLAKE2b-256 | a145ac6043bfe2ba8bdd45fd6760473876671dc753ae2d81e48c9408d7101954 |
Hashes for cylc_sphinx_extensions-1.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b19466bff0d86c063c946320cf84fd3abbeaa1b4137274012e367b2058405b9 |
|
MD5 | 148c029b3d11afa87dd7d08ae81686a0 |
|
BLAKE2b-256 | c59e25b4c49a5765f2e0a187d5cd3934872fc5dd00ebcef6a32bd2457dba6e21 |