Installing¶

Cargo Sphinx is designed for use in Git managed Cargo-based Rust projects. To install it, use:

cargo install cargo-sphinx

The following dependencies are needed to run Cargo Sphinx.

Sphinx: This is the documentation generator tool targeted by Cargo Sphinx. Currently Sphinx is the only supported documentation tool.
Python: Sphinx is written in Python and requires the interpreter to run.
Git: Cargo Sphinx expects to use version control to store the generated documentation HTML files. Currently Git is the only supported version control. This is not required if the publication features of Cargo Sphinx are not being used.
Cargo: Cargo is the Rust build tool. This project is integrated as a subcommand to Cargo.
Make: An installation of Make is needed as part of the Sphinx build. Sphinx can optionally generate a Makefile as part of project creation. Cargo Sphinx requires this Makefile to function because user Sphinx directory layouts may vary significantly. Relying on the Makefile means that Sphinx layout parameters do not need to be specified to Cargo Sphinx.
CMake: Needed by Cargo tool library dependency.
Libssl: Needed by Cargo tool library dependency.

Optionally, you may like to also install packages for extra Sphinx templates such as: