Installation guide#

Clone the repository#

To use this guide, you’ll need to clone the repository that contains the source code from Github.

git clone https://github.com/ecastroth/ultimate-sphinx-tutorial.git

Once the repository is in your machine, you have to install its dependencies.

If you want to install a full conda environment you can do:

conda env create -f requirements/conda-requirements.yaml

Once the dependencies are installed, activate the env using:

conda activate sphinx-demo

And you’re good to go! Move on to the Docstring guide.

If you want to install the dependencies with pip you can do:

pip install -r requirements/pip-requirements.yaml

And you’re good to go! Move on to the Docstring guide.