mirrors-python
/
Sphinx
mirror of https://github.com/sphinx-doc/sphinx
2
0
Fork 0
Code Issues Projects Releases Wiki Activity Software Blog
Main repository for the Sphinx documentation builder http://sphinx-doc.org/
20,450 Commits 7 Branches 194 Tags 113 MiB
Python 79.5%
JavaScript 13.1%
TeX 6.1%
HTML 0.8%
Common Lisp 0.3%
Other 0.1%
Go to file
Jean-François B 3596590317
Fix a LaTeX file info string (relates #11758) (#11761) 		2023-11-15 23:14:14 +01:00
.github Allow warnings within the coverage job 2023-09-21 09:27:04 +01:00
doc Simplify the font selection 2023-10-04 16:56:47 +01:00
sphinx Fix a LaTeX file info string (relates #11758) (#11761) 2023-11-15 23:14:14 +01:00
tests Replace the header image with a new SVG logo 2023-10-04 16:56:46 +01:00
utils Mark ``utils/bump_docker.py`` as executable 2023-09-21 09:14:38 +01:00
.codecov.yml Revert "Enable patch status check for Codecov" 2020-03-15 11:09:06 +09:00
.flake8 Remove ``jsdump`` references post removal 2023-04-28 22:50:01 +01:00
.git-blame-ignore-revs Add entries to the ``.git-blame-ignore-revs`` file 2023-04-04 22:06:49 +01:00
.gitignore Add ``tests/test-server.lock`` to ``.gitignore`` (#11520) 2023-07-27 17:58:32 +01:00
.mailmap Add git .mailmap file 2023-08-29 21:14:42 +01:00
.readthedocs.yml RTD builder: add graphviz depedendency (#11040) 2022-12-20 12:30:59 +00:00
AUTHORS.rst Adorn top-level files with a '.rst' suffix 2023-09-14 11:08:17 +01:00
CHANGES.rst Fix #11756 (#11758) 2023-11-15 17:27:14 +01:00
CODE_OF_CONDUCT.rst Adorn top-level files with a '.rst' suffix 2023-09-14 11:08:17 +01:00
CONTRIBUTING.rst Minor typo in the contributing info 2020-12-16 12:09:17 -05:00
EXAMPLES.rst Adorn top-level files with a '.rst' suffix 2023-09-14 11:08:17 +01:00
LICENSE.rst Adorn top-level files with a '.rst' suffix 2023-09-14 11:08:17 +01:00
Makefile Adorn top-level files with a '.rst' suffix 2023-09-14 11:08:17 +01:00
README.rst Remove "Release signatures" section of the README 2023-07-23 23:17:46 +01:00
bindep.txt Update bindep.txt for LaTeX pict2e.sty optional dependency 2022-07-18 19:26:08 +02:00
karma.conf.js Split out `sphinx_highlight.js` 2022-09-24 15:10:57 +01:00
package-lock.json Merge branch '4.x' into 5.x 2022-04-03 00:33:25 +09:00
package.json Merge branch '4.x' 2022-03-19 22:58:15 +09:00
pyproject.toml Adorn top-level files with a '.rst' suffix 2023-09-14 11:08:17 +01:00
tox.ini Declare support for Python 3.13 2023-08-17 04:28:52 +01:00

README.rst

Sphinx

Package on PyPI

Build Status

Documentation Status

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 the documentation.

Installation

The following command installs Sphinx from the Python Package Index. You will need a working installation of Python and pip.

pip install -U sphinx

Contributing

We appreciate all contributions! Refer to the contributors guide for information.