Fix contributing guide for building the docs (#794)

jupyter-server · Apr 20, 2022 · ef1deca · ef1deca
1 parent 6740cb5
commit ef1deca
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 1,397 deletions.
diff --git a/.gitignore b/.gitignore
@@ -35,6 +35,9 @@ config.rst
 # copied changelog file
 docs/source/other/changelog.md
 
+# full config is generated on demand
+docs/source/other/full-config.rst
+
 # jetbrains ide stuff
 *.iml
 .idea/

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -104,12 +104,11 @@ Building the Docs
 To build the documentation you'll need `Sphinx <http://www.sphinx-doc.org/en/master/>`_,
 `pandoc <https://pandoc.org/>`_ and a few other packages.
 
-To install (and activate) a `conda environment`_ named ``server_docs``
+To install (and activate) a `conda environment`_ named ``jupyter_server_docs``
 containing all the necessary packages (except pandoc), use::
 
     conda env create -f docs/environment.yml
-    source activate server_docs  # Linux and OS X
-    activate server_docs         # Windows
+    conda activate jupyter_server_docs
 
 .. _conda environment:
     https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file

diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt
@@ -1,6 +1,7 @@
 ipykernel
 jinja2
 jupyter_client
+jupyter_server
 myst-parser
 nbformat
 prometheus_client