From 302b402cf103e801f6351215c103fa0014ec407f Mon Sep 17 00:00:00 2001 From: Jayan Kuttagupthan Date: Mon, 10 Feb 2025 21:34:19 +0530 Subject: [PATCH 1/5] Update Contribution Page for Jupyter Server --- CONTRIBUTING.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1845b54745..c5b1910dc3 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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:: @@ -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 `_ 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 From 6063040c080c2a1478eeb252abcd77f4e2cfe8e8 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 11 Feb 2025 11:14:24 +0000 Subject: [PATCH 2/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c5b1910dc3..eeee569325 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -126,7 +126,7 @@ 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 `_ and the following dependencies.:: +The above may run into issues related to unavailability of sphinx and related dependencies. You can `install sphinx `_ and the following dependencies.:: pip install myst_parser sphinxcontrib_github_alt sphinxcontrib.openapi \ sphinxemoji sphinx_autodoc_typehints pydata-sphinx-theme From d2aae97cc478e61cc2eb796e77938958d3eac7a1 Mon Sep 17 00:00:00 2001 From: Jayan Kuttagupthan Date: Thu, 13 Feb 2025 14:08:55 +0530 Subject: [PATCH 3/5] Update sphinx related lines --- CONTRIBUTING.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index eeee569325..3507e8ec06 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -119,17 +119,14 @@ 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 -The above may run into issues related to unavailability of sphinx and related dependencies. You can `install sphinx `_ and the following dependencies.:: - - pip install myst_parser sphinxcontrib_github_alt sphinxcontrib.openapi \ - sphinxemoji sphinx_autodoc_typehints pydata-sphinx-theme +The above may run into issues related to unavailability of sphinx. You can `install sphinx `_ to resolve them. You can also run the tests using ``hatch`` without installing test dependencies in your local environment.:: From bbd3be34cc532fed0c208a2814d28122bd726372 Mon Sep 17 00:00:00 2001 From: Jayan Kuttagupthan Date: Sun, 23 Feb 2025 00:17:23 +0530 Subject: [PATCH 4/5] Addressing review comments --- CONTRIBUTING.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3507e8ec06..beacc9d8a3 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -126,10 +126,8 @@ 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. You can `install sphinx `_ to resolve them. - 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 From b585b4f8b2fef8423091a3c12407358186b67f00 Mon Sep 17 00:00:00 2001 From: Jayan Kuttagupthan Date: Wed, 26 Feb 2025 10:39:05 +0530 Subject: [PATCH 5/5] Fix for CI failures. files changed from docs:api run --- docs/source/api/jupyter_server.auth.rst | 16 ++++++++-------- docs/source/api/jupyter_server.base.rst | 10 +++++----- docs/source/api/jupyter_server.extension.rst | 14 +++++++------- docs/source/api/jupyter_server.files.rst | 4 ++-- docs/source/api/jupyter_server.gateway.rst | 10 +++++----- docs/source/api/jupyter_server.i18n.rst | 2 +- docs/source/api/jupyter_server.kernelspecs.rst | 4 ++-- docs/source/api/jupyter_server.nbconvert.rst | 4 ++-- docs/source/api/jupyter_server.prometheus.rst | 6 +++--- docs/source/api/jupyter_server.rst | 14 +++++++------- docs/source/api/jupyter_server.services.api.rst | 4 ++-- .../api/jupyter_server.services.config.rst | 6 +++--- .../api/jupyter_server.services.contents.rst | 16 ++++++++-------- .../api/jupyter_server.services.events.rst | 4 ++-- ...upyter_server.services.kernels.connection.rst | 8 ++++---- .../api/jupyter_server.services.kernels.rst | 8 ++++---- .../api/jupyter_server.services.kernelspecs.rst | 4 ++-- .../api/jupyter_server.services.nbconvert.rst | 4 ++-- docs/source/api/jupyter_server.services.rst | 4 ++-- .../api/jupyter_server.services.security.rst | 4 ++-- .../api/jupyter_server.services.sessions.rst | 6 +++--- docs/source/api/jupyter_server.view.rst | 4 ++-- 22 files changed, 78 insertions(+), 78 deletions(-) diff --git a/docs/source/api/jupyter_server.auth.rst b/docs/source/api/jupyter_server.auth.rst index 66c364b44c..4284b4f9df 100644 --- a/docs/source/api/jupyter_server.auth.rst +++ b/docs/source/api/jupyter_server.auth.rst @@ -7,49 +7,49 @@ Submodules .. automodule:: jupyter_server.auth.authorizer :members: - :undoc-members: :show-inheritance: + :undoc-members: .. 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: diff --git a/docs/source/api/jupyter_server.base.rst b/docs/source/api/jupyter_server.base.rst index 0a8e12c6d1..5b5dc9fb97 100644 --- a/docs/source/api/jupyter_server.base.rst +++ b/docs/source/api/jupyter_server.base.rst @@ -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: diff --git a/docs/source/api/jupyter_server.extension.rst b/docs/source/api/jupyter_server.extension.rst index 4610c696e6..31021a53ce 100644 --- a/docs/source/api/jupyter_server.extension.rst +++ b/docs/source/api/jupyter_server.extension.rst @@ -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: diff --git a/docs/source/api/jupyter_server.files.rst b/docs/source/api/jupyter_server.files.rst index 892865814a..ada8898ee9 100644 --- a/docs/source/api/jupyter_server.files.rst +++ b/docs/source/api/jupyter_server.files.rst @@ -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: diff --git a/docs/source/api/jupyter_server.gateway.rst b/docs/source/api/jupyter_server.gateway.rst index c08595e672..09c96f0c76 100644 --- a/docs/source/api/jupyter_server.gateway.rst +++ b/docs/source/api/jupyter_server.gateway.rst @@ -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: diff --git a/docs/source/api/jupyter_server.i18n.rst b/docs/source/api/jupyter_server.i18n.rst index ada5d341bb..4a3b68c3c6 100644 --- a/docs/source/api/jupyter_server.i18n.rst +++ b/docs/source/api/jupyter_server.i18n.rst @@ -6,5 +6,5 @@ Module contents .. automodule:: jupyter_server.i18n :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/docs/source/api/jupyter_server.kernelspecs.rst b/docs/source/api/jupyter_server.kernelspecs.rst index 0c36baf16e..55db0ce4be 100644 --- a/docs/source/api/jupyter_server.kernelspecs.rst +++ b/docs/source/api/jupyter_server.kernelspecs.rst @@ -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: diff --git a/docs/source/api/jupyter_server.nbconvert.rst b/docs/source/api/jupyter_server.nbconvert.rst index 52d9dc00ad..3fc66296eb 100644 --- a/docs/source/api/jupyter_server.nbconvert.rst +++ b/docs/source/api/jupyter_server.nbconvert.rst @@ -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: diff --git a/docs/source/api/jupyter_server.prometheus.rst b/docs/source/api/jupyter_server.prometheus.rst index 91a61ed686..b7b01e2753 100644 --- a/docs/source/api/jupyter_server.prometheus.rst +++ b/docs/source/api/jupyter_server.prometheus.rst @@ -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: diff --git a/docs/source/api/jupyter_server.rst b/docs/source/api/jupyter_server.rst index 6402594325..b015dd2b70 100644 --- a/docs/source/api/jupyter_server.rst +++ b/docs/source/api/jupyter_server.rst @@ -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: diff --git a/docs/source/api/jupyter_server.services.api.rst b/docs/source/api/jupyter_server.services.api.rst index e7389bc02d..865d6edae1 100644 --- a/docs/source/api/jupyter_server.services.api.rst +++ b/docs/source/api/jupyter_server.services.api.rst @@ -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: diff --git a/docs/source/api/jupyter_server.services.config.rst b/docs/source/api/jupyter_server.services.config.rst index 7f1c1d1e23..882b57c079 100644 --- a/docs/source/api/jupyter_server.services.config.rst +++ b/docs/source/api/jupyter_server.services.config.rst @@ -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: diff --git a/docs/source/api/jupyter_server.services.contents.rst b/docs/source/api/jupyter_server.services.contents.rst index bf33989ea1..a13cb48a23 100644 --- a/docs/source/api/jupyter_server.services.contents.rst +++ b/docs/source/api/jupyter_server.services.contents.rst @@ -7,49 +7,49 @@ Submodules .. automodule:: jupyter_server.services.contents.checkpoints :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.contents.filecheckpoints :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.contents.fileio :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.contents.filemanager :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.contents.handlers :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.contents.largefilemanager :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.contents.manager :members: - :undoc-members: :show-inheritance: + :undoc-members: Module contents --------------- .. automodule:: jupyter_server.services.contents :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/docs/source/api/jupyter_server.services.events.rst b/docs/source/api/jupyter_server.services.events.rst index eebb056ac6..4f0ca4934c 100644 --- a/docs/source/api/jupyter_server.services.events.rst +++ b/docs/source/api/jupyter_server.services.events.rst @@ -7,13 +7,13 @@ Submodules .. automodule:: jupyter_server.services.events.handlers :members: - :undoc-members: :show-inheritance: + :undoc-members: Module contents --------------- .. automodule:: jupyter_server.services.events :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/docs/source/api/jupyter_server.services.kernels.connection.rst b/docs/source/api/jupyter_server.services.kernels.connection.rst index 076f81c46b..ccf1d196fd 100644 --- a/docs/source/api/jupyter_server.services.kernels.connection.rst +++ b/docs/source/api/jupyter_server.services.kernels.connection.rst @@ -7,25 +7,25 @@ Submodules .. automodule:: jupyter_server.services.kernels.connection.abc :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.kernels.connection.base :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.kernels.connection.channels :members: - :undoc-members: :show-inheritance: + :undoc-members: Module contents --------------- .. automodule:: jupyter_server.services.kernels.connection :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/docs/source/api/jupyter_server.services.kernels.rst b/docs/source/api/jupyter_server.services.kernels.rst index 865db764ce..683e340a76 100644 --- a/docs/source/api/jupyter_server.services.kernels.rst +++ b/docs/source/api/jupyter_server.services.kernels.rst @@ -15,25 +15,25 @@ Submodules .. automodule:: jupyter_server.services.kernels.handlers :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.kernels.kernelmanager :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.kernels.websocket :members: - :undoc-members: :show-inheritance: + :undoc-members: Module contents --------------- .. automodule:: jupyter_server.services.kernels :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/docs/source/api/jupyter_server.services.kernelspecs.rst b/docs/source/api/jupyter_server.services.kernelspecs.rst index 3f210d0f55..96b1fe04a7 100644 --- a/docs/source/api/jupyter_server.services.kernelspecs.rst +++ b/docs/source/api/jupyter_server.services.kernelspecs.rst @@ -7,13 +7,13 @@ Submodules .. automodule:: jupyter_server.services.kernelspecs.handlers :members: - :undoc-members: :show-inheritance: + :undoc-members: Module contents --------------- .. automodule:: jupyter_server.services.kernelspecs :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/docs/source/api/jupyter_server.services.nbconvert.rst b/docs/source/api/jupyter_server.services.nbconvert.rst index cf5f0c037d..6faf19d813 100644 --- a/docs/source/api/jupyter_server.services.nbconvert.rst +++ b/docs/source/api/jupyter_server.services.nbconvert.rst @@ -7,13 +7,13 @@ Submodules .. automodule:: jupyter_server.services.nbconvert.handlers :members: - :undoc-members: :show-inheritance: + :undoc-members: Module contents --------------- .. automodule:: jupyter_server.services.nbconvert :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/docs/source/api/jupyter_server.services.rst b/docs/source/api/jupyter_server.services.rst index 6f221e7357..326e1e7c70 100644 --- a/docs/source/api/jupyter_server.services.rst +++ b/docs/source/api/jupyter_server.services.rst @@ -23,13 +23,13 @@ Submodules .. automodule:: jupyter_server.services.shutdown :members: - :undoc-members: :show-inheritance: + :undoc-members: Module contents --------------- .. automodule:: jupyter_server.services :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/docs/source/api/jupyter_server.services.security.rst b/docs/source/api/jupyter_server.services.security.rst index 7d7b2a975c..7910e44710 100644 --- a/docs/source/api/jupyter_server.services.security.rst +++ b/docs/source/api/jupyter_server.services.security.rst @@ -7,13 +7,13 @@ Submodules .. automodule:: jupyter_server.services.security.handlers :members: - :undoc-members: :show-inheritance: + :undoc-members: Module contents --------------- .. automodule:: jupyter_server.services.security :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/docs/source/api/jupyter_server.services.sessions.rst b/docs/source/api/jupyter_server.services.sessions.rst index 292de65c34..65fab14f9b 100644 --- a/docs/source/api/jupyter_server.services.sessions.rst +++ b/docs/source/api/jupyter_server.services.sessions.rst @@ -7,19 +7,19 @@ Submodules .. automodule:: jupyter_server.services.sessions.handlers :members: - :undoc-members: :show-inheritance: + :undoc-members: .. automodule:: jupyter_server.services.sessions.sessionmanager :members: - :undoc-members: :show-inheritance: + :undoc-members: Module contents --------------- .. automodule:: jupyter_server.services.sessions :members: - :undoc-members: :show-inheritance: + :undoc-members: diff --git a/docs/source/api/jupyter_server.view.rst b/docs/source/api/jupyter_server.view.rst index f83aff120e..73b5527177 100644 --- a/docs/source/api/jupyter_server.view.rst +++ b/docs/source/api/jupyter_server.view.rst @@ -7,13 +7,13 @@ Submodules .. automodule:: jupyter_server.view.handlers :members: - :undoc-members: :show-inheritance: + :undoc-members: Module contents --------------- .. automodule:: jupyter_server.view :members: - :undoc-members: :show-inheritance: + :undoc-members: