python314Packages.sphinx
Sphinx makes it easy to create intelligent and beautiful documentation.
Here are some of Sphinx’s major features:
- Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text
- Extensive cross-references: semantic markup and automatic links for functions, classes, citations, 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 language-specific module indices
- Code handling: automatic highlighting using the Pygments highlighter
- Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs) via built-in extensions, and much more functionality via third-party extensions.
- Themes: modify the look and feel of outputs via creating themes, and re-use many third-party themes.
- Contributed extensions: dozens of extensions contributed by users; most of them installable from PyPI.
Sphinx uses the reStructuredText markup language by default, and can read MyST markdown via third-party extensions. Both of these are powerful and straightforward to use, and have functionality for complex documentation and publishing workflows. They both build upon Docutils to parse and write documents.
- Name
- sphinx
- Programs
sphinx-apidocsphinx-autogensphinx-buildsphinx-quickstart
- Homepage
- Version
- 8.2.3
- License
- Platforms
- aarch64-linux
- armv5tel-linux
- armv6l-linux
- armv7a-linux
- armv7l-linux
- i686-linux
- loongarch64-linux
- m68k-linux
- microblaze-linux
- microblazeel-linux
- mips-linux
- mips64-linux
- mips64el-linux
- mipsel-linux
- powerpc-linux
- powerpc64-linux
- powerpc64le-linux
- riscv32-linux
- riscv64-linux
- s390-linux
- s390x-linux
- x86_64-linux
- x86_64-darwin
- aarch64-darwin
- aarch64-windows
- x86_64-windows
- i686-windows
- i686-freebsd
- x86_64-freebsd
- aarch64-freebsd
- Defined
- Source