{
    "info": {
        "author": "",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "Cylc Sphinx Extensions\n======================\n\nA library of 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.. code-block:: console\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``::\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\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\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "",
        "keywords": "",
        "license": "GPL",
        "maintainer": "",
        "maintainer_email": "",
        "name": "cylc-sphinx-extensions",
        "package_url": "https://pypi.org/project/cylc-sphinx-extensions/",
        "platform": "",
        "project_url": "https://pypi.org/project/cylc-sphinx-extensions/",
        "project_urls": null,
        "release_url": "https://pypi.org/project/cylc-sphinx-extensions/1.0.0/",
        "requires_dist": [
            "sphinx (>=2.0.0)",
            "hieroglyph ; extra == 'all'",
            "pygments ; extra == 'all'",
            "pycodestyle ; extra == 'all'",
            "sphinx-rtd-theme ; extra == 'all'",
            "pygments ; extra == 'cylc_lang'",
            "hieroglyph ; extra == 'hieroglyph_patch'",
            "hieroglyph ; extra == 'hieroglyph_theme_addons'",
            "sphinx-rtd-theme ; extra == 'rtd_theme_addons'",
            "pygments ; extra == 'sub_lang'",
            "pycodestyle ; extra == 'test'"
        ],
        "requires_python": "",
        "summary": "Sphinx extensions for documenting Cylc",
        "version": "1.0.0"
    },
    "last_serial": 5874283,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c28070327d1621f22c4ba4037c5484dc",
                    "sha256": "15d25c57df5516d1d4c03b693a9344b656087eda6d7f513f9d0dbfa3df81369b"
                },
                "downloads": -1,
                "filename": "cylc_sphinx_extensions-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c28070327d1621f22c4ba4037c5484dc",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 44278,
                "upload_time": "2019-09-23T14:52:10",
                "url": "https://files.pythonhosted.org/packages/18/f4/caa3f80e99eb2200983532432c4349f865cb575bbbaa84d04f1ccc35ddc7/cylc_sphinx_extensions-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "deb6c9184093cb4c46c10028fc571718",
                    "sha256": "73030223e1c2b81463140cde4e3c2ba5d6c2211ee5f6a1d7dd06a42ec11a4817"
                },
                "downloads": -1,
                "filename": "cylc-sphinx-extensions-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "deb6c9184093cb4c46c10028fc571718",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 18556,
                "upload_time": "2019-09-23T14:52:16",
                "url": "https://files.pythonhosted.org/packages/ab/82/76f9f568091627d2965252b9b09f57427b129b9d94e97116891875781786/cylc-sphinx-extensions-1.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c28070327d1621f22c4ba4037c5484dc",
                "sha256": "15d25c57df5516d1d4c03b693a9344b656087eda6d7f513f9d0dbfa3df81369b"
            },
            "downloads": -1,
            "filename": "cylc_sphinx_extensions-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c28070327d1621f22c4ba4037c5484dc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 44278,
            "upload_time": "2019-09-23T14:52:10",
            "url": "https://files.pythonhosted.org/packages/18/f4/caa3f80e99eb2200983532432c4349f865cb575bbbaa84d04f1ccc35ddc7/cylc_sphinx_extensions-1.0.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "deb6c9184093cb4c46c10028fc571718",
                "sha256": "73030223e1c2b81463140cde4e3c2ba5d6c2211ee5f6a1d7dd06a42ec11a4817"
            },
            "downloads": -1,
            "filename": "cylc-sphinx-extensions-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "deb6c9184093cb4c46c10028fc571718",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 18556,
            "upload_time": "2019-09-23T14:52:16",
            "url": "https://files.pythonhosted.org/packages/ab/82/76f9f568091627d2965252b9b09f57427b129b9d94e97116891875781786/cylc-sphinx-extensions-1.0.0.tar.gz"
        }
    ]
}