Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cylc/cylc-sphinx-extensions

Sphinx extensions for documenting Cylc projects.

https://github.com/cylc/cylc-sphinx-extensions

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.9%) to scientific vocabulary

Keywords

cylc sphinx

Keywords from Contributors

scheduler workflow-management pypy interpretability finite-volume standardization animal hack autograder report
Last synced: 5 months ago · JSON representation

Repository

Sphinx extensions for documenting Cylc projects.

Basic Info
Statistics
  • Stars: 4
  • Watchers: 6
  • Forks: 8
  • Open Issues: 10
  • Releases: 11
Topics
cylc sphinx
Created over 6 years ago · Last pushed about 1 year ago
Metadata Files
Readme Contributing License

README.rst 

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   # 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-2025 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/.

Owner

  • Name: The Cylc Workflow Engine
  • Login: cylc
  • Kind: organization
  • Email: hilary.oliver@niwa.co.nz
  • Location: Wellington, New Zealand

A workflow engine for cycling systems.

GitHub Events

Total
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 1
  • Pull request review event: 1
  • Pull request event: 2
  • Create event: 1
Last Year
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 1
  • Pull request review event: 1
  • Pull request event: 2
  • Create event: 1

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 115
  • Total Committers: 6
  • Avg Commits per committer: 19.167
  • Development Distribution Score (DDS): 0.296
Past Year
  • Commits: 8
  • Committers: 3
  • Avg Commits per committer: 2.667
  • Development Distribution Score (DDS): 0.5
Top Committers
Name Email Commits
Oliver Sanders o****s@m****k 81
github-actions[bot] 4****] 16
Ronnie Dutta 6****e 14
Hilary James Oliver h****r@g****m 2
Melanie Hall 3****l 1
Bruno P. Kinoshita k****w 1
Committer Domains (Top 20 + Academic)
metoffice.gov.uk: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 33
  • Total pull requests: 158
  • Average time to close issues: 8 months
  • Average time to close pull requests: 4 days
  • Total issue authors: 3
  • Total pull request authors: 7
  • Average comments per issue: 0.24
  • Average comments per pull request: 1.35
  • Merged pull requests: 140
  • Bot issues: 0
  • Bot pull requests: 44
Past Year
  • Issues: 3
  • Pull requests: 18
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Issue authors: 1
  • Pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.78
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 7
View more stats
Top Authors
Issue Authors
  • oliver-sanders (15)
  • github-actions[bot] (1)
  • MetRonnie (1)
  • elliotfontaine (1)
Pull Request Authors
  • oliver-sanders (37)
  • github-actions[bot] (19)
  • MetRonnie (12)
  • wxtim (4)
  • kinow (2)
  • hjoliver (2)
  • datamel (1)
Top Labels
Issue Labels
bug (4) release (1)
Pull Request Labels
release (13) bug (9) documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,204 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 12
  • Total maintainers: 3
pypi.org: cylc-sphinx-extensions

Sphinx extensions for documenting Cylc

  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 1,204 Last month
Rankings
Downloads: 8.6%
Dependent packages count: 10.1%
Average: 13.4%
Dependent repos count: 21.6%
Maintainers (3)
wxtim oliver-sanders revilo666
Last synced: 6 months ago

Dependencies

setup.py pypi
  • sphinx >=2.1
.github/workflows/1_create_release_pr.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • cylc/release-actions/stage-1/checkout-pr-branch v1 composite
  • cylc/release-actions/stage-1/create-release-pr v1 composite
  • cylc/release-actions/stage-1/sanitize-inputs v1 composite
  • cylc/release-actions/stage-1/set-python-package-version v1 composite
.github/workflows/2_auto_publish_release.yml actions
  • actions/checkout v2 composite
  • actions/create-release v1 composite
  • actions/setup-python v2 composite
  • cylc/release-actions/build-python-package v1 composite
  • cylc/release-actions/stage-2/comment-on-pr v1 composite
  • cylc/release-actions/stage-2/get-version-from-pr v1 composite
  • peaceiris/actions-gh-pages bbdfb200618d235585ad98e965f4aafc39b4c501 composite
  • pypa/gh-action-pypi-publish v1.4.1 composite
.github/workflows/test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/update_copyright.yml actions
  • actions/checkout v2 composite
  • cylc/release-actions/checkout-copyright-branch v1 composite
  • cylc/release-actions/configure-git v1 composite
  • cylc/release-actions/create-pr v1 composite