Skip to content

Commit

Permalink
Update Contribution Page for Jupyter Server
Browse files Browse the repository at this point in the history
  • Loading branch information
jayankg-aws committed Feb 11, 2025
1 parent edb2f1b commit d2fba9e
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Running Tests

Install dependencies::

pip install -e .[test]
pip install -e ".[test]"
pip install -e examples/simple # to test the examples

To run the Python tests, use::
Expand All @@ -119,15 +119,20 @@ Building the Docs

Install the docs requirements using ``pip``::

pip install .[doc]
pip install ".[doc]"

Once you have installed the required packages, you can build the docs with::

cd docs
make html

The above may run into issues related to unavailability of sphinx and related dependencies. You can `install sphinx <https://www.sphinx-doc.org/en/master/usage/installation.html>`_ and the following dependencies.::

pip install myst_parser sphinxcontrib_github_alt sphinxcontrib.openapi \
sphinxemoji sphinx_autodoc_typehints pydata-sphinx-theme

You can also run the tests using ``hatch`` without installing test dependencies
in your local environment.
in your local environment.::

pip install hatch
hatch run docs:build
Expand Down

0 comments on commit d2fba9e

Please sign in to comment.