sphinx
- The Sphinx documentation toolchain.addnodes
- Document tree nodes that Sphinx defines on top of those in Docutils.application
- Sphinx application class and extensibility interface.builders
- Builder superclass for all builders.changes
- Changelog builder.dirhtml
- Directory HTML builders.dummy
- Do syntax checks, but no writing.epub3
- Build epub3 files.gettext
- The MessageCatalogBuilder class.html
- Several HTML builders.transforms
- Transforms for HTML builder.latex
- LaTeX builder.constants
- consntants for LaTeX builder.nodes
- Additional nodes for LaTeX writer.theming
- Theming support for LaTeX builder.transforms
- Transforms for LaTeX builder.util
- Utilities for LaTeX builder.linkcheck
- The CheckExternalLinksBuilder class.manpage
- Manual pages builder.singlehtml
- Single HTML builders.texinfo
- Texinfo builder.text
- Plain-text Sphinx builder.xml
- Docutils-native XML and pseudo-XML builders._epub_base
- Base class of epub2/epub3 builders.cmd
- Modules for command line executables.build
- Build documentation from a provided source.make_mode
- sphinx-build -M command-line handling.quickstart
- Quickly setup documentation source to work with Sphinx.config
- Build configuration file handling.deprecation
- Sphinx deprecation classes and utilities.directives
- Handlers for additional ReST directives.domains
- Support for domains.environment
- Global creation environment.adapters
- Sphinx environment adaptersasset
- Assets adapter for sphinx.environment.indexentries
- Index entries adapters for sphinx.environment.toctree
- Toctree adapter for sphinx.environment.collectors
- The data collector components for sphinx.environment.asset
- The image collector for sphinx.environment.dependencies
- The dependencies collector components for sphinx.environment.metadata
- The metadata collector components for sphinx.environment.title
- The title collector components for sphinx.environment.toctree
- Toctree collector for sphinx.environment.errors
- Contains SphinxError and a few subclasses.events
- Sphinx core events.ext
- Contains Sphinx features not activated by default.apidoc
- Creates reST files corresponding to Python modules for code documentation.autodoc
- Extension to create automatic documentation from code docstrings.directive
- No module docstring; 0/1 variable, 0/2 constant, 2/2 functions, 3/3 classes documentedimporter
- Importer utilities for autodocmock
- mock for autodocpreserve_defaults
- Preserve function defaults.type_comment
- Update annotations info of living objects using type_comments.typehints
- Generating content for autodoc using typehintsautosectionlabel
- Allow reference sections by :ref: role using its title.autosummary
- Extension that adds an autosummary:: directive.generate
- Generates reST source files for autosummary.coverage
- Check Python modules and C API for coverage.doctest
- Mimic doctest in Sphinx.duration
- Measure durations of Sphinx processing.extlinks
- Extension to save typing and prevent hard-coding of base URLs in reST files.githubpages
- To publish HTML docs at GitHub Pages, create .nojekyll file.graphviz
- Allow graphviz-formatted graphs to be included inline in generated documents.ifconfig
- Provides the ``ifconfig`` directive.imgconverter
- Image converter extension for Sphinximgmath
- Render math in HTML via dvipng or dvisvgm.inheritance_diagram
- Defines a docutils directive for inserting inheritance diagrams.intersphinx
- Insert links to objects documented in remote Sphinx documentation.linkcode
- Add external links to module code in Python object descriptions.mathjax
- Allow `MathJax`_ to be used to display math in Sphinx's HTML writer.napoleon
- Support for NumPy and Google style docstrings.todo
- Allow todos to be inserted into your documentation.viewcode
- Add links to module code in Python object descriptions.extension
- Utilities for Sphinx extensions.highlighting
- Highlight code blocks using Pygments.io
- Input/Output filesjinja2glue
- Glue code for the jinja2 templating engine.locale
- Locale utilities.parsers
- A Base class for additional parsers.project
- Utility function and classes for Sphinx projects.pycode
- Utilities parsing and analyzing Python code.pygments_styles
- Sphinx theme specific highlighting styles.registry
- Sphinx component registry.roles
- Handlers for additional ReST roles.search
- Create a full-text search index for offline search.da
- Danish search language: includes the JS Danish stemmer.de
- German search language: includes the JS German stemmer.en
- English search language: includes the JS porter stemmer.es
- Spanish search language: includes the JS Spanish stemmer.fi
- Finnish search language: includes the JS Finnish stemmer.fr
- French search language: includes the JS French stemmer.hu
- Hungarian search language: includes the JS Hungarian stemmer.it
- Italian search language: includes the JS Italian stemmer.ja
- Japanese search language: includes routine to split words.nl
- Dutch search language: includes the JS porter stemmer.no
- Norwegian search language: includes the JS Norwegian stemmer.pt
- Portuguese search language: includes the JS Portuguese stemmer.ro
- Romanian search language: includes the JS Romanian stemmer.ru
- Russian search language: includes the JS Russian stemmer.sv
- Swedish search language: includes the JS Swedish stemmer.tr
- Turkish search language: includes the JS Turkish stemmer.zh
- Chinese search language: includes routine to split words.setup_command
- Setuptools/distutils commands to assist the building of sphinx documentation.testing
- Sphinx test utilitiescomparer
- Sphinx test comparer for pytestfixtures
- Sphinx test fixtures for pytestpath
- No module docstring; 0/2 constant, 1/1 function, 1/1 class documentedrestructuredtext
- No module docstring; 1/1 function documentedutil
- Sphinx test suite utilitiestheming
- Theming support for HTML builders.transforms
- Docutils transforms used by Sphinx when reading documents.compact_bullet_list
- Docutils transforms used by Sphinx when reading documents.i18n
- Docutils transforms used by Sphinx when reading documents.post_transforms
- Docutils transforms used by Sphinx.references
- Docutils transforms used by Sphinx.util
- Utility functions for Sphinx.build_phase
- Build phase of Sphinx application.cfamily
- Utility functions common to the C and C++ domains.console
- Format colored console output.display
- Undocumenteddocfields
- Utility code for "Doc fields".docstrings
- Utilities for docstring processing.docutils
- Utility functions for docutils.exceptions
- No module docstring; 2/2 functions documentedfileutil
- File utility functions for Sphinx.http_date
- Convert times to and from HTTP-date serialisations.i18n
- Builder superclass for all builders.images
- Image utility functions for Sphinx.inspect
- Helpers for inspecting Python modules.inventory
- Inventory utility functions for Sphinx.jsdump
- This module implements a simple JavaScript serializer.logging
- Logging utility functions for Sphinx.matching
- Pattern-matching utility functions for Sphinx.math
- Utility functions for math.nodes
- Docutils node-related utility functions for Sphinx.osutil
- Operating system-related utility functions for Sphinx.parallel
- Parallel building utilities.png
- PNG image manipulation helpers.requests
- Simple requests package loaderrst
- reST helper functions.stemmer
- Word stemming utilities for Sphinx.tags
- No module docstring; 0/1 variable, 1/2 class documentedtemplate
- Templates utility functions for Sphinx.texescape
- TeX escaping helper.typing
- The composite types for Sphinx.versioning
- Implements the low-level algorithms Sphinx uses for versioning doctrees.writers
- Custom docutils writers.html
- docutils writers handling Sphinx' custom nodes.html5
- Experimental docutils writers for HTML5 handling Sphinx's custom nodes.latex
- Custom docutils writer for LaTeX.manpage
- Manual page writer, extended for Sphinx custom nodes.texinfo
- Custom docutils writer for Texinfo.text
- Custom docutils writer for plain text.xml
- Docutils-native XML and pseudo-XML writers._html4
- Frozen HTML 4 translator.__main__
- The Sphinx documentation toolchain.