docs: relocate source files from docs to docs/source

jupyterhub · Nov 4, 2022 · 693c961 · 693c961
1 parent 0bae110
commit 693c961
Show file tree

Hide file tree

Showing 18 changed files with 14 additions and 17 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -4,6 +4,9 @@
 #
 version: 2
 
+sphinx:
+  configuration: docs/source/conf.py
+
 build:
   os: ubuntu-22.04
   tools:
@@ -12,6 +15,3 @@ build:
 python:
   install:
     - requirements: docs/requirements.txt
-
-sphinx:
-  configuration: docs/conf.py
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ The primary use cases are:
     JupyterLab extensions) to access web APIs of other processes running
     locally in a safe manner. This is used by the [JupyterLab
     extension](https://github.com/dask/dask-labextension) for
-    [dask](https://dask.org/).
+    [dask](https://www.dask.org/).
 
 [The documentation](https://jupyter-server-proxy.readthedocs.io/)
 contains information on installation & usage.

diff --git a/docs/Makefile b/docs/Makefile
@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
+SOURCEDIR     = source
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".

diff --git a/docs/convenience/packages/theia.rst b/docs/convenience/packages/theia.rst
diff --git a/docs/make.bat b/docs/make.bat
@@ -7,7 +7,7 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=.
+set SOURCEDIR=source
 set BUILDDIR=_build
 
 if "%1" == "" goto help

diff --git a/docs/images/labextension-launcher.png → .../_static/images/labextension-launcher.png b/docs/images/labextension-launcher.png → .../_static/images/labextension-launcher.png
diff --git a/docs/_static/images/logo/favicon.ico → docs/source/_static/images/logo/favicon.ico b/docs/_static/images/logo/favicon.ico → docs/source/_static/images/logo/favicon.ico
diff --git a/docs/images/nbextension-tree.png → ...ource/_static/images/nbextension-tree.png b/docs/images/nbextension-tree.png → ...ource/_static/images/nbextension-tree.png
diff --git a/docs/arbitrary-ports-hosts.rst → docs/source/arbitrary-ports-hosts.rst b/docs/arbitrary-ports-hosts.rst → docs/source/arbitrary-ports-hosts.rst
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
@@ -53,18 +53,15 @@
 # -- Options for HTML output -------------------------------------------------
 # ref: http://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-# FIXME: change to pydata_sphinx_theme
+# FIXME: change to sphinx_book_theme or pydata_sphinx_theme
+#
+# Alabaster theme options: https://alabaster.readthedocs.io/en/latest/customization.html#theme-options
 html_theme = "alabaster"
 html_theme_options = {
-    "github_url": "https://github.com/jupyterhub/jupyter-server-proxy/",
-    "use_edit_page_button": True,
-}
-html_context = {
     "github_user": "jupyterhub",
     "github_repo": "jupyter-server-proxy",
-    "github_version": "main",
-    "doc_path": "docs",
 }
+html_context = {}
 
 html_favicon = "_static/images/logo/favicon.ico"
 # FIXME: Add project logo

diff --git a/docs/contributing/release.rst → docs/source/contributing/release.rst b/docs/contributing/release.rst → docs/source/contributing/release.rst
diff --git a/docs/convenience/new.rst → docs/source/convenience/new.rst b/docs/convenience/new.rst → docs/source/convenience/new.rst
diff --git a/docs/source/convenience/packages/theia.rst b/docs/source/convenience/packages/theia.rst
@@ -0,0 +1 @@
+../../../../contrib/theia/README.rst
diff --git a/docs/examples.rst → docs/source/examples.rst b/docs/examples.rst → docs/source/examples.rst
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
@@ -21,7 +21,7 @@ The primary use cases are:
    JupyterLab extensions) to access web APIs of other processes
    running locally in a safe manner. This is used by the `JupyterLab
    extension <https://github.com/dask/dask-labextension>`_ for
-   `dask <https://dask.org/>`_.
+   `dask <https://www.dask.org/>`_.
 
 
 Contents

diff --git a/docs/install.rst → docs/source/install.rst b/docs/install.rst → docs/source/install.rst
diff --git a/docs/launchers.rst → docs/source/launchers.rst b/docs/launchers.rst → docs/source/launchers.rst
@@ -16,7 +16,7 @@ menu in the notebook's default tree view. Note that a new instance
 is **not** launched every time you click an item - if the process
 is already running, it is reused.
 
-.. image:: images/nbextension-tree.png
+.. image:: _static/images/nbextension-tree.png
 
 JupyterLab Launcher Extension
 =============================
@@ -31,6 +31,6 @@ to provide launcher icons for registered server processes.
 This should provide icons for each registered process in the main
 JupyterLab launcher
 
-.. image:: images/labextension-launcher.png
+.. image:: _static/images/labextension-launcher.png
 
 Clicking on them will open the application in a new window.
diff --git a/docs/server-process.rst → docs/source/server-process.rst b/docs/server-process.rst → docs/source/server-process.rst