Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix contributing guide for building the docs #794

Merged
merged 2 commits into from
Apr 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
5 changes: 2 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/doc-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
ipykernel
jinja2
jupyter_client
jupyter_server
myst-parser
nbformat
prometheus_client
Expand Down
Loading