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-2023 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.4.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 578ba6a36adc76598fb630423cad1992abfc168ff8d9e414dc44dde7983d3db1 |
|
MD5 | ffac706594e48def630600b6b721628d |
|
BLAKE2b-256 | fdd66e7dab6de7d7e10f63f8bee1485a66bb76774d0e777869b479cea3f65d7a |
Hashes for cylc_sphinx_extensions-1.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 944564cf8cb9ef1d4fff52eae40019d0bed882dafc10f988f9e6c95ab6b7af8b |
|
MD5 | ae69cef3ea27984acf122bc9eefcf18e |
|
BLAKE2b-256 | 23f0f713c8ef1765ce997f8e52c58e8be4eea1c4725c19d4f8a76536e9722cad |