IntenseWebs
/
sphinx
mirror of https://github.com/sphinx-doc/sphinx.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The Sphinx documentation generator
20,848 Commits 4 Branches 202 Tags 151 MiB
Python 80.3%
JavaScript 12.7%
TeX 5.9%
HTML 0.7%
Common Lisp 0.3%
Other 0.1%
Go to file
Michał Górny ce86026f3b
DEPS: Lazy import `defusedxml` only when necessary (#12362) 
The `defusedxml` dependency was added to `sphinx.testing` in sphinx 7.3,
but it is not part of the core sphinx dependencies, and not strictly necessary for the running of the pytest plugin.
This commit moves the import into the only function which uses it,
so that the pytest plugins can be used again without this dependency.
 		2024-05-11 18:31:02 +02:00
.github Install epubcheck for Docutils HEAD tests (#12272) 2024-04-12 21:32:19 +01:00
doc DOCS: improve `:tocdepth:` note (#12356) 2024-05-07 04:49:08 +02:00
sphinx DEPS: Lazy import `defusedxml` only when necessary (#12362) 2024-05-11 18:31:02 +02:00
tests Extract inner check functions in ``test_domain_cpp`` (#12336) 2024-04-29 02:07:56 +01:00
utils Update pattern in ``utils/bump_docker.py`` 2024-04-25 21:13:33 +01:00
.codecov.yml Revert "Enable patch status check for Codecov" 2020-03-15 11:09:06 +09:00
.flake8 [doc] cleanup references and update external URLs (#12182) 2024-03-25 11:39:05 +01:00
.git-blame-ignore-revs Add 2024 copyright year update to ``.git-blame-ignore-revs`` 2024-01-16 22:15:22 +00:00
.gitignore [lint] ignore ``venv`` directory (#12138) 2024-03-19 11:07:08 +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
.ruff.toml Add ``sphinx._cli`` (#10877) 2024-04-29 03:03:15 +01:00
AUTHORS.rst Add new maintainers 2024-01-15 08:11:51 +00:00
CHANGES.rst Add a CHANGES entry for #12314 2024-04-29 01:10:15 +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 Update EXAMPLES.rst: Linux kernel switched theme (#12348) 2024-05-05 19:07:32 +02:00
LICENSE.rst Happy New Year! 2024-01-16 22:13:47 +00:00
Makefile [doc] cleanup references and update external URLs (#12182) 2024-03-25 11:39:05 +01:00
README.rst [docs] Remove duplicate "the" from README file (#11835) 2024-01-01 15:39:09 +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 [javascript] Update vulnerable dependencies using 'npm audit fix'. (#12101) 2024-03-15 17:58:24 +01:00
package.json Merge branch '4.x' 2022-03-19 22:58:15 +09:00
pyproject.toml Update to mypy 1.10 2024-04-25 16:04:06 +01:00
tox.ini Declare support for Python 3.13 2023-08-17 04:28:52 +01:00

README.rst 

========
 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:: sh

   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/