Skip to content

Commit ef1deca

Browse files
authored
Fix contributing guide for building the docs (#794)
1 parent 6740cb5 commit ef1deca

File tree

4 files changed

+6
-1397
lines changed

4 files changed

+6
-1397
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ config.rst
3535
# copied changelog file
3636
docs/source/other/changelog.md
3737

38+
# full config is generated on demand
39+
docs/source/other/full-config.rst
40+
3841
# jetbrains ide stuff
3942
*.iml
4043
.idea/

CONTRIBUTING.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,11 @@ Building the Docs
104104
To build the documentation you'll need `Sphinx <http://www.sphinx-doc.org/en/master/>`_,
105105
`pandoc <https://pandoc.org/>`_ and a few other packages.
106106

107-
To install (and activate) a `conda environment`_ named ``server_docs``
107+
To install (and activate) a `conda environment`_ named ``jupyter_server_docs``
108108
containing all the necessary packages (except pandoc), use::
109109

110110
conda env create -f docs/environment.yml
111-
source activate server_docs # Linux and OS X
112-
activate server_docs # Windows
111+
conda activate jupyter_server_docs
113112

114113
.. _conda environment:
115114
https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file

docs/doc-requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
ipykernel
22
jinja2
33
jupyter_client
4+
jupyter_server
45
myst-parser
56
nbformat
67
prometheus_client

0 commit comments

Comments
 (0)