Browse Source

Update docs (#10543)

* Update docs

* Add missing dependencies
Carlos Herrero 3 years ago
parent
commit
d5906e5906
2 changed files with 8 additions and 2 deletions
  1. 2 0
      docs/environment.yml
  2. 6 2
      docs/source/developer/contributing.rst

+ 2 - 0
docs/environment.yml

@@ -8,6 +8,8 @@ dependencies:
 - sphinx-copybutton
 - sphinx_rtd_theme
 - pytest
+- pytest-tornasync
+- pytest-check-links
 - pip
 - nodejs
 - jsx-lexer

+ 6 - 2
docs/source/developer/contributing.rst

@@ -718,11 +718,15 @@ Writing Documentation
 Documentation is written in Markdown and reStructuredText. In
 particular, the documentation on our Read the Docs page is written in
 reStructuredText. To ensure that the Read the Docs page builds, you'll
-need to install the documentation dependencies with ``pip``:
+need to install the documentation dependencies with ``conda``:
 
 .. code:: bash
 
-   pip install -r docs/requirements.txt
+   conda env create -f docs/environment.yml
+
+.. code:: bash
+
+   conda activate jupyterlab_documentation
 
 
 To test the docs run: