sphinx-toolbox


Namesphinx-toolbox JSON
Version 0.9.1 PyPI version JSON
download
home_pagehttps://github.com/domdfcoding/sphinx-toolbox
SummaryBox of handy tools for Sphinx.
upload_time2020-09-18 19:40:29
maintainer
docs_urlNone
authorDominic Davis-Foster
requires_python>=3.6
licenseMIT License
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ###############
sphinx-toolbox
###############

.. start short_desc

**Box of handy tools for Sphinx.**

.. end short_desc


.. start shields

.. list-table::
	:stub-columns: 1
	:widths: 10 90

	* - Docs
	  - |docs| |docs_check|
	* - Tests
	  - |travis| |actions_windows| |actions_macos| |coveralls| |codefactor|
	* - PyPI
	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
	* - Anaconda
	  - |conda-version| |conda-platform|
	* - Activity
	  - |commits-latest| |commits-since| |maintained|
	* - Other
	  - |license| |language| |requires| |pre_commit|

.. |docs| image:: https://img.shields.io/readthedocs/sphinx-toolbox/latest?logo=read-the-docs
	:target: https://sphinx-toolbox.readthedocs.io/en/latest/?badge=latest
	:alt: Documentation Build Status

.. |docs_check| image:: https://github.com/domdfcoding/sphinx-toolbox/workflows/Docs%20Check/badge.svg
	:target: https://github.com/domdfcoding/sphinx-toolbox/actions?query=workflow%3A%22Docs+Check%22
	:alt: Docs Check Status

.. |travis| image:: https://img.shields.io/travis/com/domdfcoding/sphinx-toolbox/master?logo=travis
	:target: https://travis-ci.com/domdfcoding/sphinx-toolbox
	:alt: Travis Build Status

.. |actions_windows| image:: https://github.com/domdfcoding/sphinx-toolbox/workflows/Windows%20Tests/badge.svg
	:target: https://github.com/domdfcoding/sphinx-toolbox/actions?query=workflow%3A%22Windows+Tests%22
	:alt: Windows Tests Status

.. |actions_macos| image:: https://github.com/domdfcoding/sphinx-toolbox/workflows/macOS%20Tests/badge.svg
	:target: https://github.com/domdfcoding/sphinx-toolbox/actions?query=workflow%3A%22macOS+Tests%22
	:alt: macOS Tests Status

.. |requires| image:: https://requires.io/github/domdfcoding/sphinx-toolbox/requirements.svg?branch=master
	:target: https://requires.io/github/domdfcoding/sphinx-toolbox/requirements/?branch=master
	:alt: Requirements Status

.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/sphinx-toolbox/master?logo=coveralls
	:target: https://coveralls.io/github/domdfcoding/sphinx-toolbox?branch=master
	:alt: Coverage

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/sphinx-toolbox?logo=codefactor
	:target: https://www.codefactor.io/repository/github/domdfcoding/sphinx-toolbox
	:alt: CodeFactor Grade

.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-toolbox
	:target: https://pypi.org/project/sphinx-toolbox/
	:alt: PyPI - Package Version

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-toolbox?logo=python&logoColor=white
	:target: https://pypi.org/project/sphinx-toolbox/
	:alt: PyPI - Supported Python Versions

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-toolbox
	:target: https://pypi.org/project/sphinx-toolbox/
	:alt: PyPI - Supported Implementations

.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-toolbox
	:target: https://pypi.org/project/sphinx-toolbox/
	:alt: PyPI - Wheel

.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/sphinx-toolbox?logo=anaconda
	:target: https://anaconda.org/domdfcoding/sphinx-toolbox
	:alt: Conda - Package Version

.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/sphinx-toolbox?label=conda%7Cplatform
	:target: https://anaconda.org/domdfcoding/sphinx-toolbox
	:alt: Conda - Platform

.. |license| image:: https://img.shields.io/github/license/domdfcoding/sphinx-toolbox
	:target: https://github.com/domdfcoding/sphinx-toolbox/blob/master/LICENSE
	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/sphinx-toolbox
	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/sphinx-toolbox/v0.9.1
	:target: https://github.com/domdfcoding/sphinx-toolbox/pulse
	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/sphinx-toolbox
	:target: https://github.com/domdfcoding/sphinx-toolbox/commit/master
	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2020
	:alt: Maintenance

.. |pre_commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
	:target: https://github.com/pre-commit/pre-commit
	:alt: pre-commit

.. end shields

|

Installation
--------------

.. start installation

``sphinx-toolbox`` can be installed from PyPI or Anaconda.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install sphinx-toolbox

To install with ``conda``:

	* First add the required channels

	.. code-block:: bash

		$ conda config --add channels http://conda.anaconda.org/domdfcoding
		$ conda config --add channels http://conda.anaconda.org/conda-forge

	* Then install

	.. code-block:: bash

		$ conda install sphinx-toolbox

.. end installation



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/domdfcoding/sphinx-toolbox",
    "name": "sphinx-toolbox",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Dominic Davis-Foster",
    "author_email": "dominic@davis-foster.co.uk",
    "download_url": "https://files.pythonhosted.org/packages/e4/d3/c4c25671a5ad8f2db756ff0045b3c0942753319fd8619c977fad66dc3c8d/sphinx-toolbox-0.9.1.tar.gz",
    "platform": "Windows",
    "description": "###############\nsphinx-toolbox\n###############\n\n.. start short_desc\n\n**Box of handy tools for Sphinx.**\n\n.. end short_desc\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t  - |docs| |docs_check|\n\t* - Tests\n\t  - |travis| |actions_windows| |actions_macos| |coveralls| |codefactor|\n\t* - PyPI\n\t  - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Anaconda\n\t  - |conda-version| |conda-platform|\n\t* - Activity\n\t  - |commits-latest| |commits-since| |maintained|\n\t* - Other\n\t  - |license| |language| |requires| |pre_commit|\n\n.. |docs| image:: https://img.shields.io/readthedocs/sphinx-toolbox/latest?logo=read-the-docs\n\t:target: https://sphinx-toolbox.readthedocs.io/en/latest/?badge=latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/domdfcoding/sphinx-toolbox/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/domdfcoding/sphinx-toolbox/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |travis| image:: https://img.shields.io/travis/com/domdfcoding/sphinx-toolbox/master?logo=travis\n\t:target: https://travis-ci.com/domdfcoding/sphinx-toolbox\n\t:alt: Travis Build Status\n\n.. |actions_windows| image:: https://github.com/domdfcoding/sphinx-toolbox/workflows/Windows%20Tests/badge.svg\n\t:target: https://github.com/domdfcoding/sphinx-toolbox/actions?query=workflow%3A%22Windows+Tests%22\n\t:alt: Windows Tests Status\n\n.. |actions_macos| image:: https://github.com/domdfcoding/sphinx-toolbox/workflows/macOS%20Tests/badge.svg\n\t:target: https://github.com/domdfcoding/sphinx-toolbox/actions?query=workflow%3A%22macOS+Tests%22\n\t:alt: macOS Tests Status\n\n.. |requires| image:: https://requires.io/github/domdfcoding/sphinx-toolbox/requirements.svg?branch=master\n\t:target: https://requires.io/github/domdfcoding/sphinx-toolbox/requirements/?branch=master\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/sphinx-toolbox/master?logo=coveralls\n\t:target: https://coveralls.io/github/domdfcoding/sphinx-toolbox?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/sphinx-toolbox?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/domdfcoding/sphinx-toolbox\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinx-toolbox\n\t:target: https://pypi.org/project/sphinx-toolbox/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-toolbox?logo=python&logoColor=white\n\t:target: https://pypi.org/project/sphinx-toolbox/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-toolbox\n\t:target: https://pypi.org/project/sphinx-toolbox/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-toolbox\n\t:target: https://pypi.org/project/sphinx-toolbox/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/sphinx-toolbox?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/sphinx-toolbox\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/sphinx-toolbox?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/sphinx-toolbox\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/domdfcoding/sphinx-toolbox\n\t:target: https://github.com/domdfcoding/sphinx-toolbox/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/sphinx-toolbox\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/sphinx-toolbox/v0.9.1\n\t:target: https://github.com/domdfcoding/sphinx-toolbox/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/sphinx-toolbox\n\t:target: https://github.com/domdfcoding/sphinx-toolbox/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2020\n\t:alt: Maintenance\n\n.. |pre_commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n\t:target: https://github.com/pre-commit/pre-commit\n\t:alt: pre-commit\n\n.. end shields\n\n|\n\nInstallation\n--------------\n\n.. start installation\n\n``sphinx-toolbox`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install sphinx-toolbox\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels http://conda.anaconda.org/domdfcoding\n\t\t$ conda config --add channels http://conda.anaconda.org/conda-forge\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install sphinx-toolbox\n\n.. end installation\n\n\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Box of handy tools for Sphinx.",
    "version": "0.9.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "d9d9baebc45d03686b92d6d3b80aa94b",
                "sha256": "238a37e626fb588b26b1a1e750ad88381e6e1c774ebccca60e85dbbd64629396"
            },
            "downloads": -1,
            "filename": "sphinx_toolbox-0.9.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d9d9baebc45d03686b92d6d3b80aa94b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 96509,
            "upload_time": "2020-09-18T19:40:27",
            "upload_time_iso_8601": "2020-09-18T19:40:27.920468Z",
            "url": "https://files.pythonhosted.org/packages/ac/bd/6b2fec22f8cf5d8320ebbc890c3be86b5d4dce3c3f1b42eb994c72bf2b7c/sphinx_toolbox-0.9.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "2a4cce677aafc412fc770a1a0ebc3411",
                "sha256": "8426d392da72d1ee73813470e39d6dd9e0c9898e5cd4e1aab121d525a47781db"
            },
            "downloads": -1,
            "filename": "sphinx-toolbox-0.9.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2a4cce677aafc412fc770a1a0ebc3411",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 47968,
            "upload_time": "2020-09-18T19:40:29",
            "upload_time_iso_8601": "2020-09-18T19:40:29.678874Z",
            "url": "https://files.pythonhosted.org/packages/e4/d3/c4c25671a5ad8f2db756ff0045b3c0942753319fd8619c977fad66dc3c8d/sphinx-toolbox-0.9.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-09-18 19:40:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "domdfcoding",
    "error": "Could not fetch GitHub repository",
    "lcname": "sphinx-toolbox"
}
        
Elapsed time: 0.15150s