sphinx-argparse


Namesphinx-argparse JSON
Version 0.5.2 PyPI version JSON
download
home_pageNone
SummaryA sphinx extension that automatically documents argparse commands and options
upload_time2024-07-17 12:08:08
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =================
 sphinx-argparse
=================

.. image:: https://img.shields.io/pypi/v/sphinx-argparse.svg
   :target: https://pypi.org/project/sphinx-argparse/
   :alt: PyPI version

.. image:: https://img.shields.io/conda/vn/conda-forge/sphinx-argparse.svg
   :target: https://github.com/conda-forge/sphinx-argparse-feedstock/
   :alt: Conda version

.. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg
   :target: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml
   :alt: Build Status

.. image:: https://readthedocs.org/projects/sphinx-argparse/badge/?version=stable
   :target: https://sphinx-argparse.readthedocs.org/
   :alt: Documentation Status

.. image:: https://img.shields.io/badge/License-MIT-blue.svg
   :target: https://opensource.org/licenses/MIT
   :alt: MIT

A Sphinx extension to automatically document argparse_ commands and options.

For installation and usage details see the documentation_.
The changelog is also `found there`_.

.. _argparse: https://docs.python.org/3/library/argparse.html
.. _documentation: https://sphinx-argparse.readthedocs.org/
.. _found there: https://sphinx-argparse.readthedocs.org/en/latest/changelog.html

.. note::
   This project used to live at `alex-rudakov/sphinx-argparse`_,
   and has been revived and moved to this `new home`_.

   .. _alex-rudakov/sphinx-argparse: https://github.com/alex-rudakov/sphinx-argparse/
   .. _new home: https://github.com/sphinx-doc/sphinx-argparse/


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sphinx-argparse",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Ash Berlin-Taylor <ash_github@firemirror.com>",
    "download_url": "https://files.pythonhosted.org/packages/3b/21/a8c64e6633652111e6e4f89703182a53cbc3ed67233523e47472101358b6/sphinx_argparse-0.5.2.tar.gz",
    "platform": null,
    "description": "=================\n sphinx-argparse\n=================\n\n.. image:: https://img.shields.io/pypi/v/sphinx-argparse.svg\n   :target: https://pypi.org/project/sphinx-argparse/\n   :alt: PyPI version\n\n.. image:: https://img.shields.io/conda/vn/conda-forge/sphinx-argparse.svg\n   :target: https://github.com/conda-forge/sphinx-argparse-feedstock/\n   :alt: Conda version\n\n.. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg\n   :target: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml\n   :alt: Build Status\n\n.. image:: https://readthedocs.org/projects/sphinx-argparse/badge/?version=stable\n   :target: https://sphinx-argparse.readthedocs.org/\n   :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/License-MIT-blue.svg\n   :target: https://opensource.org/licenses/MIT\n   :alt: MIT\n\nA Sphinx extension to automatically document argparse_ commands and options.\n\nFor installation and usage details see the documentation_.\nThe changelog is also `found there`_.\n\n.. _argparse: https://docs.python.org/3/library/argparse.html\n.. _documentation: https://sphinx-argparse.readthedocs.org/\n.. _found there: https://sphinx-argparse.readthedocs.org/en/latest/changelog.html\n\n.. note::\n   This project used to live at `alex-rudakov/sphinx-argparse`_,\n   and has been revived and moved to this `new home`_.\n\n   .. _alex-rudakov/sphinx-argparse: https://github.com/alex-rudakov/sphinx-argparse/\n   .. _new home: https://github.com/sphinx-doc/sphinx-argparse/\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A sphinx extension that automatically documents argparse commands and options",
    "version": "0.5.2",
    "project_urls": {
        "Changelog": "https://sphinx-argparse.readthedocs.io/en/latest/changelog.html",
        "Code": "https://github.com/sphinx-doc/sphinx-argparse/",
        "Download": "https://pypi.org/project/sphinx-argparse/",
        "Homepage": "https://sphinx-argparse.readthedocs.io/",
        "Issue tracker": "https://github.com/sphinx-doc/sphinx-argparse/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e5439f0e9bfb3ce02cbf7747aa2185c48a9d6e42ba95736a5e8f511a5054d976",
                "md5": "f175ee7478d3da46fb41f1020659e4c3",
                "sha256": "d771b906c36d26dee669dbdbb5605c558d9440247a5608b810f7fa6e26ab1fd3"
            },
            "downloads": -1,
            "filename": "sphinx_argparse-0.5.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f175ee7478d3da46fb41f1020659e4c3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 12547,
            "upload_time": "2024-07-17T12:08:06",
            "upload_time_iso_8601": "2024-07-17T12:08:06.307703Z",
            "url": "https://files.pythonhosted.org/packages/e5/43/9f0e9bfb3ce02cbf7747aa2185c48a9d6e42ba95736a5e8f511a5054d976/sphinx_argparse-0.5.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3b21a8c64e6633652111e6e4f89703182a53cbc3ed67233523e47472101358b6",
                "md5": "d12461005ef9b3a160053fa6f7aa75a2",
                "sha256": "e5352f8fa894b6fb6fda0498ba28a9f8d435971ef4bbc1a6c9c6414e7644f032"
            },
            "downloads": -1,
            "filename": "sphinx_argparse-0.5.2.tar.gz",
            "has_sig": false,
            "md5_digest": "d12461005ef9b3a160053fa6f7aa75a2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 27838,
            "upload_time": "2024-07-17T12:08:08",
            "upload_time_iso_8601": "2024-07-17T12:08:08.219956Z",
            "url": "https://files.pythonhosted.org/packages/3b/21/a8c64e6633652111e6e4f89703182a53cbc3ed67233523e47472101358b6/sphinx_argparse-0.5.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-17 12:08:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sphinx-doc",
    "github_project": "sphinx-argparse",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sphinx-argparse"
}
        
Elapsed time: 1.83239s