| Name | cylc-sphinx-extensions JSON |
| Version |
1.4.3
JSON |
| download |
| home_page | None |
| Summary | Sphinx extensions for documenting Cylc |
| upload_time | 2024-09-26 12:07:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | GPL |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Cylc Sphinx Extensions
======================
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-2024 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/.
Raw data
{
"_id": null,
"home_page": null,
"name": "cylc-sphinx-extensions",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/42/68/502bcc70e41f071d7e91ffe9f95277d5d919b5faaf206bdcea3f98c4ba65/cylc-sphinx-extensions-1.4.3.tar.gz",
"platform": null,
"description": "Cylc Sphinx Extensions\n======================\n\nA library of Sphinx extensions for documenting Cylc projects.\n\n\nInstallation\n------------\n\nInstall all extensions (but not dependencies)::\n\n $ pip install cylc-sphinx-extensions\n\nOR all extensions + dependencies for specified extension(s) by name::\n\n $ pip install cylc-sphinx-extensions.git[cylc_lang]\n\nOR all extensions + dependencies for all extensions::\n\n $ pip install cylc-sphinx-extensions.git[all]\n\nNote the ``minicylc`` extension requires ``graphviz``::\n\n # install graphviz from your package manager e.g:\n $ sudo apt-get install -y graphviz\n\n\nUsage\n-----\n\nTo use an extension register it in your project's ``conf.py`` e.g::\n\n extension = [\n 'cylc.sphinx_ext.cylc_lang'\n ]\n\nSome of these extensions are \"auto-loading\" and do not require any extra steps\nto activate.\n\nIf the ``html_static_path`` configuration is set in your ``conf.py`` you will\nneed to move this into a ``setup`` function, otherwise extensions cannot append\nto this path to add their own static resources e.g::\n\n def setup(app):\n app.config.html_static_path.append('_static')\n\n\nDevelopment\n-----------\n\nFork and clone ``https://github.com/cylc/cylc-sphinx-extensions.git``.\n\nExtensions are auto-documented from their module docstrings.\n\nBuild documentation by running::\n\n $ make clean <format> # e.g. make html slides\n\nThis documentation build serves as a simple test battery (warnings will cause\nit to fail), for everything else there's pytest::\n\n $ pytest\n\nFor code linting::\n\n $ pycodestyle . # python\n $ eslint cylc/ # javascript\n\n\nCopyright and Terms of Use\n--------------------------\n\nCopyright (C) 2008-2024 NIWA & British Crown (Met Office) & Contributors.\n\nCylc is free software: you can redistribute it and/or modify it under the terms\nof the GNU General Public License as published by the Free Software Foundation,\neither version 3 of the License, or (at your option) any later version.\n\nCylc is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with\nCylc. If not, see GNU licenses http://www.gnu.org/licenses/.\n\n\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Sphinx extensions for documenting Cylc",
"version": "1.4.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59c45e3e2414941f1fbae2d062f6fce00940636ace250288e532cba8e826ec35",
"md5": "d806fbd287a723179b7dca94066e8021",
"sha256": "c69e86293725b1379dbb25509c247b91191c88d24011370320c552a36e3a38f2"
},
"downloads": -1,
"filename": "cylc_sphinx_extensions-1.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d806fbd287a723179b7dca94066e8021",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 60550,
"upload_time": "2024-09-26T12:07:50",
"upload_time_iso_8601": "2024-09-26T12:07:50.318539Z",
"url": "https://files.pythonhosted.org/packages/59/c4/5e3e2414941f1fbae2d062f6fce00940636ace250288e532cba8e826ec35/cylc_sphinx_extensions-1.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4268502bcc70e41f071d7e91ffe9f95277d5d919b5faaf206bdcea3f98c4ba65",
"md5": "16561fbcfcea21fe62cb803e746ad49d",
"sha256": "663c984c0da25a2a193333742d285718ff0333b65106a3d7e5a077bcd5a0c2b9"
},
"downloads": -1,
"filename": "cylc-sphinx-extensions-1.4.3.tar.gz",
"has_sig": false,
"md5_digest": "16561fbcfcea21fe62cb803e746ad49d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32034,
"upload_time": "2024-09-26T12:07:51",
"upload_time_iso_8601": "2024-09-26T12:07:51.572880Z",
"url": "https://files.pythonhosted.org/packages/42/68/502bcc70e41f071d7e91ffe9f95277d5d919b5faaf206bdcea3f98c4ba65/cylc-sphinx-extensions-1.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-26 12:07:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cylc-sphinx-extensions"
}
