Skip to content

Update Contribution Page for Jupyter Server #1499

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Mar 7, 2025
Merged

Update Contribution Page for Jupyter Server #1499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
302b402
Update Contribution Page for Jupyter Server
kjayan Feb 10, 2025
6063040
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 11, 2025
d2aae97
Update sphinx related lines
kjayan Feb 13, 2025
bbd3be3
Addressing review comments
kjayan Feb 22, 2025
b585b4f
Fix for CI failures. files changed from docs:api run
kjayan Feb 26, 2025
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
View file
Open in desktop
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,15 @@ Building the Docs

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

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

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

cd docs
make html

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
16 changes: 8 additions & 8 deletions docs/source/api/jupyter_server.auth.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,49 +7,49 @@ Submodules

.. automodule:: jupyter_server.auth.authorizer
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the order make a difference here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure about that, but the CI is generating the same changes, this was what failed the CI in previous commits. @kjayan Would help to check with others in the JupyterLab weekly call, before we merge.

Copy link

@andrii-i andrii-i Feb 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tagging @vidartf as discussed in the community call.



.. automodule:: jupyter_server.auth.decorator
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.auth.identity
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.auth.login
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.auth.logout
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.auth.security
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.auth.utils
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server.auth
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
10 changes: 5 additions & 5 deletions docs/source/api/jupyter_server.base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,31 @@ Submodules

.. automodule:: jupyter_server.base.call_context
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.base.handlers
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.base.websocket
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.base.zmqhandlers
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server.base
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
14 changes: 7 additions & 7 deletions docs/source/api/jupyter_server.extension.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,43 +7,43 @@ Submodules

.. automodule:: jupyter_server.extension.application
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.extension.config
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.extension.handler
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.extension.manager
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.extension.serverextension
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.extension.utils
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server.extension
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
4 changes: 2 additions & 2 deletions docs/source/api/jupyter_server.files.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Submodules

.. automodule:: jupyter_server.files.handlers
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server.files
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
10 changes: 5 additions & 5 deletions docs/source/api/jupyter_server.gateway.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,31 @@ Submodules

.. automodule:: jupyter_server.gateway.connections
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.gateway.gateway_client
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.gateway.handlers
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.gateway.managers
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server.gateway
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
2 changes: 1 addition & 1 deletion docs/source/api/jupyter_server.i18n.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ Module contents

.. automodule:: jupyter_server.i18n
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
4 changes: 2 additions & 2 deletions docs/source/api/jupyter_server.kernelspecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Submodules

.. automodule:: jupyter_server.kernelspecs.handlers
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server.kernelspecs
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
4 changes: 2 additions & 2 deletions docs/source/api/jupyter_server.nbconvert.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Submodules

.. automodule:: jupyter_server.nbconvert.handlers
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server.nbconvert
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
6 changes: 3 additions & 3 deletions docs/source/api/jupyter_server.prometheus.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Submodules

.. automodule:: jupyter_server.prometheus.log_functions
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.prometheus.metrics
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server.prometheus
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
14 changes: 7 additions & 7 deletions docs/source/api/jupyter_server.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,43 +25,43 @@ Submodules

.. automodule:: jupyter_server.config_manager
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.log
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.serverapp
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.traittypes
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.transutils
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.utils
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
4 changes: 2 additions & 2 deletions docs/source/api/jupyter_server.services.api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Submodules

.. automodule:: jupyter_server.services.api.handlers
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server.services.api
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
6 changes: 3 additions & 3 deletions docs/source/api/jupyter_server.services.config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Submodules

.. automodule:: jupyter_server.services.config.handlers
:members:
:undoc-members:
:show-inheritance:
:undoc-members:


.. automodule:: jupyter_server.services.config.manager
:members:
:undoc-members:
:show-inheritance:
:undoc-members:

Module contents
---------------

.. automodule:: jupyter_server.services.config
:members:
:undoc-members:
:show-inheritance:
:undoc-members:
Loading