https://github.com/sphinx-doc/sphinx

The Sphinx documentation generator
https://github.com/sphinx-doc/sphinx

docs documentation documentation-tool markdown python restructuredtext sphinx

Last synced: 5 days ago
JSON representation

The Sphinx documentation generator

• Host: GitHub
• URL: https://github.com/sphinx-doc/sphinx
• Owner: sphinx-doc
• License: other
• Created: 2015-01-02T10:53:28.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-12-29T22:40:00.000Z (13 days ago)
• Last Synced: 2024-12-30T12:48:15.352Z (12 days ago)
• Topics: docs, documentation, documentation-tool, markdown, python, restructuredtext, sphinx
• Language: Python
• Homepage: https://www.sphinx-doc.org/
• Size: 92.6 MB
• Stars: 6,697
• Watchers: 162
• Forks: 2,139
• Open Issues: 1,320
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.rst
  • Code of conduct: CODE_OF_CONDUCT.rst
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• awesome-fluid-dynamics - sphinx-doc/sphinx - Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects.  (Reproducibility / Benchmarks)
• awesome-python-applications - Repo - doc.org/)) Documentation tool for interconnected bodies of authorship, from code documentation to books. Used by [the official Python docs](https://docs.python.org), and many other projects ([not all of them Python](https://varnish-cache.org/docs/)). `(console)` (<a id="tag-dev" href="#tag-dev">Dev</a> / <a id="tag-dev.docs" href="#tag-dev.docs">Docs</a>)
• awesome-python-resources - GitHub - 16% open · ⏱️ 23.08.2022): (文档)
• best-of-python-dev - GitHub - 17% open · ⏱️ 29.05.2024): (Documentation)
• awesome-opensource-hardware - sphinx
• my-awesome - sphinx-doc / sphinx - :white_check_mark: Main repository for the Sphinx documentation builder. (Tool)
• awesome-open-source-systems - Sphinx - Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects. (Documentation Builder / Follow me)
• awesome-python-applications - Repo - doc.org/), [PyPI](https://pypi.org/project/Sphinx)) Documentation tool for interconnected bodies of authorship, from code documentation to books. Used by [the official Python docs](https://docs.python.org), and many other projects ([not all of them Python](https://varnish-cache.org/docs/)). `(console)` (<a id="tag-dev" href="#tag-dev">Dev</a> / <a id="tag-dev.docs" href="#tag-dev.docs">Docs</a>)
• starred-awesome - sphinx - Main repository for the Sphinx documentation builder (Python)
• my-awesome - sphinx-doc/sphinx - tool,markdown,python,restructuredtext,sphinx pushed_at:2025-01 star:6.7k fork:2.1k The Sphinx documentation generator (Python)
• awesome-documentation - Sphinx - doc/sphinx) - Make it easy to create intelligent and beautiful documentation. (General Tools / Site Builder)

README

        
========

 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/