From 7d391a65e42407e7fec2948ced13a538bb0d09d4 2017-11-21 18:57:05 From: Doug Latornell Date: 2017-11-21 18:57:05 Subject: [PATCH] Improve local docs building docs to ensure all dependencies are installed. --- diff --git a/docs/README.rst b/docs/README.rst index c7e55ed..b5ba14e 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -16,22 +16,17 @@ Requirements The documentation must be built using Python 3. -The following tools are needed to build the documentation: +In additions to :ref:`devinstall`, +the following tools are needed to build the documentation: - sphinx - sphinx_rtd_theme + - docrepr -On Debian-based systems, you should be able to run:: +In a conda environment, or a Python 3 ``venv``, you should be able to run:: - sudo apt-get install python3-sphinx python3-sphinx-rtd-theme - -In a conda environment, you can use:: - - conda install sphinx sphinx_rtd_theme - -In a Python 3 ``venv``, you should be able to run:: - - pip install -U sphinx sphinx_rtd_theme + cd ipython + pip install -U -r docs/requirements.txt Build Commands