From b4a87b8c621f7c5a964db764a3486de452e09ece Mon Sep 17 00:00:00 2001 From: Jeremy Tuloup Date: Thu, 13 Jun 2019 11:59:37 +0200 Subject: [PATCH] Clarify the steps to build the docs locally * Add `cd docs/` * Install all requirements with `pip install -r requirements.txt` --- docs/contributing/docs.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/contributing/docs.rst b/docs/contributing/docs.rst index 9480889..be6d6ae 100644 --- a/docs/contributing/docs.rst +++ b/docs/contributing/docs.rst @@ -48,11 +48,12 @@ documentation is transformed into HTML, PDF, and any other output format. __ http://sphinx-doc.org/ __ http://docutils.sourceforge.net/ -To build the documentation locally, install Sphinx: +To build the documentation locally, install the Sphinx dependencies: .. code-block:: console - $ pip install Sphinx + $ cd docs/ + $ pip install -r requirements.txt Then from the ``docs`` directory, build the HTML: