Using the Sphinx Documentation System

Sphinx is a documentation system that uses Python's docutils package to render reStructuredText document sources into a variety of formats, including HTML, PDF, and EPUB.

Sphinx also extends reStructuredText through plugins that typically add new directives and text roles, providing many nice features that make document creation easy.

Installing Sphinx with Python/pip

The best way to install Sphinx on Fedora is through Python's package manager, pip. If you have pip installed, run the following command:

pip install sphinx

To update sphinx to the latest version, just run:

pip upgrade sphinx


PDF Support

Sphinx offers PDF support through LaTeX, a free typesetting system that you must install separately if you want PDF support. Thankfully, it's pretty easy to do...

Installing LaTeX on Fedora

On Fedora, you can use the texlive-collection-latexextra package to install everything you need to generate PDF files with Sphinx. Just open a command-line and type the following:

sudo yum install texlive-collection-latexextra