snakedoc


Namesnakedoc JSON
Version 0.2.2 PyPI version JSON
download
home_pageNone
SummaryA Sphinx extension for Snakemake
upload_time2023-12-01 03:12:42
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://smutch.github.io/snakedoc/_images/snakedoc-logo.svg
   :width: 30%
   :align: center
   :class: no-scaled-link

A `Sphinx`_ extension for `Snakemake`_ workflows.

|tests badge| |coverage badge| |pre-commit badge|
|git3moji badge| |black badge| |isort badge|

`Snakemake`_ workflows can be complicated and difficult to follow, especially
for new users. Having good documentation explaining what each rule is doing,
what assumptions are being made, and what parts can be configured are important
for understandable and reusable workflows. `Snakedoc`_ aims to help with this
by:

1. encouraging developers to write contextual and useful docstrings, inline
   with their rules; and
2. providing a way to automatically scrape those docstrings and present them in
   Sphinx documentation where they can be further augmented as needed.


Where to go from here
---------------------

* See the `installation <https://smutch.github.io/snakedoc/installation.html>`_
  page how to install Snakedoc.
* To get started, check out the `guide
  <https://smutch.github.io/snakedoc/guide.html>`_.



.. _Sphinx: https://www.sphinx-doc.org/
.. _Snakemake: https://snakemake.readthedocs.io/
.. _Snakedoc: https://smutch.github.io/snakedoc/

.. |tests badge| image:: https://github.com/smutch/snakedoc/actions/workflows/tests.yaml/badge.svg
   :target: https://github.com/smutch/snakedoc/actions/workflows/tests.yaml
   :alt: tests status

.. |coverage badge| image:: https://codecov.io/gh/smutch/snakedoc/branch/main/graph/badge.svg?token=JJNMO2HMG6
   :target: https://codecov.io/gh/smutch/snakedoc
   :alt: coverage statistic

.. |pre-commit badge| image:: https://results.pre-commit.ci/badge/github/smutch/snakedoc/main.svg
   :target: https://results.pre-commit.ci/latest/github/smutch/snakedoc/main
   :alt: pre-commit.ci status

.. |git3moji badge| image:: https://img.shields.io/badge/git3moji-%E2%9A%A1%EF%B8%8F%F0%9F%90%9B%F0%9F%93%BA%F0%9F%91%AE%F0%9F%94%A4-fffad8.svg?style=flat-square
   :target: https://robinpokorny.github.io/git3moji/
   :alt: git3moji

.. |black badge| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Formatted with black

.. |isort badge| image:: https://img.shields.io/badge/imports-isort-ef8336.svg
   :target: https://github.com/pycqa/isort
   :alt: Imports formatted with isort

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "snakedoc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Simon Mutch <smutch@unimelb.edu.au>",
    "download_url": "https://files.pythonhosted.org/packages/2c/aa/0b2f3db588a3a960493b04373580c7a77d2c32b6df7284cf40015a9b7268/snakedoc-0.2.2.tar.gz",
    "platform": null,
    "description": ".. image:: https://smutch.github.io/snakedoc/_images/snakedoc-logo.svg\n   :width: 30%\n   :align: center\n   :class: no-scaled-link\n\nA `Sphinx`_ extension for `Snakemake`_ workflows.\n\n|tests badge| |coverage badge| |pre-commit badge|\n|git3moji badge| |black badge| |isort badge|\n\n`Snakemake`_ workflows can be complicated and difficult to follow, especially\nfor new users. Having good documentation explaining what each rule is doing,\nwhat assumptions are being made, and what parts can be configured are important\nfor understandable and reusable workflows. `Snakedoc`_ aims to help with this\nby:\n\n1. encouraging developers to write contextual and useful docstrings, inline\n   with their rules; and\n2. providing a way to automatically scrape those docstrings and present them in\n   Sphinx documentation where they can be further augmented as needed.\n\n\nWhere to go from here\n---------------------\n\n* See the `installation <https://smutch.github.io/snakedoc/installation.html>`_\n  page how to install Snakedoc.\n* To get started, check out the `guide\n  <https://smutch.github.io/snakedoc/guide.html>`_.\n\n\n\n.. _Sphinx: https://www.sphinx-doc.org/\n.. _Snakemake: https://snakemake.readthedocs.io/\n.. _Snakedoc: https://smutch.github.io/snakedoc/\n\n.. |tests badge| image:: https://github.com/smutch/snakedoc/actions/workflows/tests.yaml/badge.svg\n   :target: https://github.com/smutch/snakedoc/actions/workflows/tests.yaml\n   :alt: tests status\n\n.. |coverage badge| image:: https://codecov.io/gh/smutch/snakedoc/branch/main/graph/badge.svg?token=JJNMO2HMG6\n   :target: https://codecov.io/gh/smutch/snakedoc\n   :alt: coverage statistic\n\n.. |pre-commit badge| image:: https://results.pre-commit.ci/badge/github/smutch/snakedoc/main.svg\n   :target: https://results.pre-commit.ci/latest/github/smutch/snakedoc/main\n   :alt: pre-commit.ci status\n\n.. |git3moji badge| image:: https://img.shields.io/badge/git3moji-%E2%9A%A1%EF%B8%8F%F0%9F%90%9B%F0%9F%93%BA%F0%9F%91%AE%F0%9F%94%A4-fffad8.svg?style=flat-square\n   :target: https://robinpokorny.github.io/git3moji/\n   :alt: git3moji\n\n.. |black badge| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n   :target: https://github.com/psf/black\n   :alt: Formatted with black\n\n.. |isort badge| image:: https://img.shields.io/badge/imports-isort-ef8336.svg\n   :target: https://github.com/pycqa/isort\n   :alt: Imports formatted with isort\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Sphinx extension for Snakemake",
    "version": "0.2.2",
    "project_urls": {
        "Documentation": "https://github.com/smutch/snakedoc#readme",
        "Issues": "https://github.com/smutch/snakedoc/issues",
        "Source": "https://github.com/smutch/snakedoc"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8b7eab53e750ecdd0cbd7bc6e2ea415cc37884d7f98cef6be784538558016fb1",
                "md5": "d69224e367d92aae9b00da89df2e05e3",
                "sha256": "25256b21812ec1683009d965c186f33b48819e7c3373d290e05c8e782db398ad"
            },
            "downloads": -1,
            "filename": "snakedoc-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d69224e367d92aae9b00da89df2e05e3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 12927,
            "upload_time": "2023-12-01T03:12:40",
            "upload_time_iso_8601": "2023-12-01T03:12:40.460938Z",
            "url": "https://files.pythonhosted.org/packages/8b/7e/ab53e750ecdd0cbd7bc6e2ea415cc37884d7f98cef6be784538558016fb1/snakedoc-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2caa0b2f3db588a3a960493b04373580c7a77d2c32b6df7284cf40015a9b7268",
                "md5": "0cb41439258cba564f96b8360d05ba5c",
                "sha256": "4bc45ead2920dbb757eaeaaa1d3b2a57f49d3e18f72f4eec23464b2fc6beb652"
            },
            "downloads": -1,
            "filename": "snakedoc-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "0cb41439258cba564f96b8360d05ba5c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 24476,
            "upload_time": "2023-12-01T03:12:42",
            "upload_time_iso_8601": "2023-12-01T03:12:42.152839Z",
            "url": "https://files.pythonhosted.org/packages/2c/aa/0b2f3db588a3a960493b04373580c7a77d2c32b6df7284cf40015a9b7268/snakedoc-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-01 03:12:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "smutch",
    "github_project": "snakedoc#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "snakedoc"
}
        
Elapsed time: 0.24993s