%general-entities; ]> Sphinx-&sphinx-version; sphinx Introduction to Sphinx Module The Sphinx package is a set of tools for translating some structured text formats into pretty documentation in various formats. &lfs121_checked; Package Information Download (HTTP): Download (FTP): Download MD5 sum: &sphinx-md5sum; Download size: &sphinx-size; Estimated disk space required: &sphinx-buildsize; Estimated build time: &sphinx-time; Sphinx Dependencies Required , , , , , , , , , , , , , and Optional (for tests) , , , filelock, and html5lib Installation of Sphinx Build the module: &build-wheel; Now, as the root user: &install-wheel; sphinx Assuming and are installed, but the other optional dependencies are not, the installation can be tested with the following commands: python3 -m venv --system-site-packages testenv && source testenv/bin/activate && pip3 install html5lib filelock && python3 -m pytest deactivate Contents Installed Programs Installed Libraries Installed Directories sphinx-apidoc, sphinx-autogen, sphinx-build, and sphinx-quickstart None /usr/lib/python&python3-majorver;/site-packages/sphinx and /usr/lib/python&python3-majorver;/site-packages/sphinx-&sphinx-version;.dist-info Short Descriptions sphinx-apidoc creates an reST file from python modules and packages sphinx-apidoc sphinx-autogen generates ReStructuredText from special directives contained in given input files sphinx-autogen sphinx-build generates documentation in various formats from ReStructuredText source files sphinx-build sphinx-quickstart generates required files for a sphinx project sphinx-quickstart