diff --git a/docs/README.md b/docs/README.md index de37f7cba1..be9fe95b2b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,25 +1,25 @@ # Generating the documentation To generate the documentation, you first have to build it. Several packages are necessary to build the doc, -you can install them using: +you can install them with the following command, at the root of the code repository: ```bash -pip install -r requirements.txt +pip install .[docs] ``` - + ## Packages installed -Here's an overview of all the packages installed. If you ran the previous command installing all packages from +Here's an overview of all the packages installed. If you ran the previous command installing all packages from `requirements.txt`, you do not need to run the following commands. -Building it requires the package `sphinx` that you can +Building it requires the package `sphinx` that you can install using: ```bash pip install -U sphinx ``` -You would also need the custom installed [theme](https://github.com/readthedocs/sphinx_rtd_theme) by +You would also need the custom installed [theme](https://github.com/readthedocs/sphinx_rtd_theme) by [Read The Docs](https://readthedocs.org/). You can install it using the following command: ```bash @@ -34,7 +34,7 @@ pip install recommonmark ## Building the documentation -Make sure that there is a symlink from the `example` file (in /examples) inside the source folder. Run the following +Make sure that there is a symlink from the `example` file (in /examples) inside the source folder. Run the following command to generate it: ```bash diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 63480293f5..0000000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,32 +0,0 @@ -alabaster==0.7.12 -Babel==2.7.0 -certifi==2019.6.16 -chardet==3.0.4 -commonmark==0.9.0 -docutils==0.14 -future==0.17.1 -idna==2.8 -imagesize==1.1.0 -Jinja2==2.10.1 -MarkupSafe==1.1.1 -packaging==19.0 -Pygments==2.4.2 -pyparsing==2.4.0 -pytz==2019.1 -recommonmark==0.5.0 -requests==2.22.0 -six==1.12.0 -snowballstemmer==1.9.0 -Sphinx==2.1.2 -sphinx-rtd-theme==0.4.3 -sphinxcontrib-applehelp==1.0.1 -sphinxcontrib-devhelp==1.0.1 -sphinxcontrib-htmlhelp==1.0.2 -sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.2 -sphinxcontrib-serializinghtml==1.1.3 -urllib3==1.25.3 -sphinx-markdown-tables==0.0.9 -numpy==1.17.2 -tensorflow==2.0.0rc2 -torch==1.2.0 \ No newline at end of file