| Name | Sphinx JSON |
| Version |
8.1.3
JSON |
| download |
| home_page | None |
| Summary | Python documentation generator |
| upload_time | 2024-10-13 20:27:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
========
Sphinx
========
.. image:: https://img.shields.io/pypi/v/sphinx.svg
:target: https://pypi.org/project/Sphinx/
:alt: Package on PyPI
.. 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/badge/?version=master
:target: https://www.sphinx-doc.org/
:alt: Documentation Status
.. image:: https://img.shields.io/badge/License-BSD%202--Clause-blue.svg
:target: https://opensource.org/licenses/BSD-2-Clause
:alt: BSD 2 Clause
**Sphinx makes it easy to create intelligent and beautiful documentation.**
Sphinx uses reStructuredText as its markup language, and many of its strengths
come from the power and straightforwardness of reStructuredText and its parsing
and translating suite, the Docutils.
Features
========
* **Output formats**: HTML, PDF, plain text, EPUB, TeX, manual pages, and more
* **Extensive cross-references**: semantic markup and automatic links
for functions, classes, glossary terms and similar pieces of information
* **Hierarchical structure**: easy definition of a document tree, with automatic
links to siblings, parents and children
* **Automatic indices**: general index as well as a module index
* **Code highlighting**: automatic highlighting using the Pygments highlighter
* **Templating**: Flexible HTML output using the Jinja 2 templating engine
* **Extension ecosystem**: Many extensions are available, for example for
automatic function documentation or working with Jupyter notebooks.
* **Language Support**: Python, C, C++, JavaScript, mathematics, and many other
languages through extensions.
For more information, refer to `the documentation`_.
Installation
============
The following command installs Sphinx from the `Python Package Index`_. You will
need a working installation of Python and pip.
.. code-block:: shell
pip install -U sphinx
Contributing
============
We appreciate all contributions! Refer to `the contributors guide`_ for
information.
.. _the documentation: https://www.sphinx-doc.org/
.. _the contributors guide: https://www.sphinx-doc.org/en/master/internals/contributing.html
.. _Python Package Index: https://pypi.org/project/Sphinx/
Raw data
{
"_id": null,
"home_page": null,
"name": "Sphinx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Georg Brandl <georg@python.org>",
"download_url": "https://files.pythonhosted.org/packages/6f/6d/be0b61178fe2cdcb67e2a92fc9ebb488e3c51c4f74a36a7824c0adf23425/sphinx-8.1.3.tar.gz",
"platform": null,
"description": "========\n Sphinx\n========\n\n.. image:: https://img.shields.io/pypi/v/sphinx.svg\n :target: https://pypi.org/project/Sphinx/\n :alt: Package on PyPI\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/badge/?version=master\n :target: https://www.sphinx-doc.org/\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/License-BSD%202--Clause-blue.svg\n :target: https://opensource.org/licenses/BSD-2-Clause\n :alt: BSD 2 Clause\n\n**Sphinx makes it easy to create intelligent and beautiful documentation.**\n\nSphinx uses reStructuredText as its markup language, and many of its strengths\ncome from the power and straightforwardness of reStructuredText and its parsing\nand translating suite, the Docutils.\n\nFeatures\n========\n\n* **Output formats**: HTML, PDF, plain text, EPUB, TeX, manual pages, and more\n* **Extensive cross-references**: semantic markup and automatic links\n for functions, classes, glossary terms and similar pieces of information\n* **Hierarchical structure**: easy definition of a document tree, with automatic\n links to siblings, parents and children\n* **Automatic indices**: general index as well as a module index\n* **Code highlighting**: automatic highlighting using the Pygments highlighter\n* **Templating**: Flexible HTML output using the Jinja 2 templating engine\n* **Extension ecosystem**: Many extensions are available, for example for\n automatic function documentation or working with Jupyter notebooks.\n* **Language Support**: Python, C, C++, JavaScript, mathematics, and many other\n languages through extensions.\n\nFor more information, refer to `the documentation`_.\n\nInstallation\n============\n\nThe following command installs Sphinx from the `Python Package Index`_. You will\nneed a working installation of Python and pip.\n\n.. code-block:: shell\n\n pip install -U sphinx\n\nContributing\n============\n\nWe appreciate all contributions! Refer to `the contributors guide`_ for\ninformation.\n\n.. _the documentation: https://www.sphinx-doc.org/\n.. _the contributors guide: https://www.sphinx-doc.org/en/master/internals/contributing.html\n.. _Python Package Index: https://pypi.org/project/Sphinx/\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python documentation generator",
"version": "8.1.3",
"project_urls": {
"Changelog": "https://www.sphinx-doc.org/en/master/changes.html",
"Code": "https://github.com/sphinx-doc/sphinx",
"Documentation": "https://www.sphinx-doc.org/",
"Download": "https://pypi.org/project/Sphinx/",
"Homepage": "https://www.sphinx-doc.org/",
"Issue tracker": "https://github.com/sphinx-doc/sphinx/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26601ddff83a56d33aaf6f10ec8ce84b4c007d9368b21008876fceda7e7381ef",
"md5": "3bcca8b62843f94429276a0bf1c90c28",
"sha256": "09719015511837b76bf6e03e42eb7595ac8c2e41eeb9c29c5b755c6b677992a2"
},
"downloads": -1,
"filename": "sphinx-8.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3bcca8b62843f94429276a0bf1c90c28",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3487125,
"upload_time": "2024-10-13T20:27:10",
"upload_time_iso_8601": "2024-10-13T20:27:10.448453Z",
"url": "https://files.pythonhosted.org/packages/26/60/1ddff83a56d33aaf6f10ec8ce84b4c007d9368b21008876fceda7e7381ef/sphinx-8.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6f6dbe0b61178fe2cdcb67e2a92fc9ebb488e3c51c4f74a36a7824c0adf23425",
"md5": "845210d4c36be0dac08ec2ce2411a194",
"sha256": "43c1911eecb0d3e161ad78611bc905d1ad0e523e4ddc202a58a821773dc4c927"
},
"downloads": -1,
"filename": "sphinx-8.1.3.tar.gz",
"has_sig": false,
"md5_digest": "845210d4c36be0dac08ec2ce2411a194",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 8184611,
"upload_time": "2024-10-13T20:27:13",
"upload_time_iso_8601": "2024-10-13T20:27:13.930361Z",
"url": "https://files.pythonhosted.org/packages/6f/6d/be0b61178fe2cdcb67e2a92fc9ebb488e3c51c4f74a36a7824c0adf23425/sphinx-8.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-13 20:27:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-doc",
"github_project": "sphinx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinx"
}
