Add api docs (#1159)

* add api docs

* debug

* more debug

* try again

* try again

* try again

* deps

Co-authored-by: Carol Willing <[email protected]>

.github/workflows/python-tests.yml

@@ -61,6 +61,15 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install enchant-2  # for spell checking
+      - name: Build API docs
+        run: |
+          hatch run docs:api
+          # If this fails run `hatch run docs:api` locally
+          # and commit.
+          git status --porcelain
+          git status -s | grep "A" && exit 1
+          git status -s | grep "M" && exit 1
+          echo "API docs done"
       - run: hatch run docs:build
 
   test_lint:

docs/source/api/jupyter_server.auth.rst

@@ -0,0 +1,55 @@
+jupyter\_server.auth package
+============================
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.auth.authorizer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.auth.decorator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.auth.identity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.auth.login
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.auth.logout
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.auth.security
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.auth.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.auth
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.base.rst

@@ -0,0 +1,31 @@
+jupyter\_server.base package
+============================
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.base.handlers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.base.websocket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.base.zmqhandlers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.base
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.extension.rst

@@ -0,0 +1,49 @@
+jupyter\_server.extension package
+=================================
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.extension.application
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.extension.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.extension.handler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.extension.manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.extension.serverextension
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.extension.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.extension
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.files.rst

@@ -0,0 +1,19 @@
+jupyter\_server.files package
+=============================
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.files.handlers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.files
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.gateway.rst

@@ -0,0 +1,31 @@
+jupyter\_server.gateway package
+===============================
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.gateway.gateway_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.gateway.handlers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.gateway.managers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.gateway
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.i18n.rst

@@ -0,0 +1,10 @@
+jupyter\_server.i18n package
+============================
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.i18n
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.kernelspecs.rst

@@ -0,0 +1,19 @@
+jupyter\_server.kernelspecs package
+===================================
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.kernelspecs.handlers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.kernelspecs
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.nbconvert.rst

@@ -0,0 +1,19 @@
+jupyter\_server.nbconvert package
+=================================
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.nbconvert.handlers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.nbconvert
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.prometheus.rst

@@ -0,0 +1,25 @@
+jupyter\_server.prometheus package
+==================================
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.prometheus.log_functions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.prometheus.metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.prometheus
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.rst

@@ -0,0 +1,67 @@
+jupyter\_server package
+=======================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   jupyter_server.auth
+   jupyter_server.base
+   jupyter_server.extension
+   jupyter_server.files
+   jupyter_server.gateway
+   jupyter_server.i18n
+   jupyter_server.kernelspecs
+   jupyter_server.nbconvert
+   jupyter_server.prometheus
+   jupyter_server.services
+   jupyter_server.view
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.config_manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.log
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.serverapp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.traittypes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.transutils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.services.api.rst

@@ -0,0 +1,19 @@
+jupyter\_server.services.api package
+====================================
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.services.api.handlers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.services.api
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/api/jupyter_server.services.config.rst

@@ -0,0 +1,25 @@
+jupyter\_server.services.config package
+=======================================
+
+Submodules
+----------
+
+
+.. automodule:: jupyter_server.services.config.handlers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: jupyter_server.services.config.manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: jupyter_server.services.config
+   :members:
+   :undoc-members:
+   :show-inheritance: