From 693c9613ac9c07ea3d998ac54e78454d832c5c17 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Fri, 4 Nov 2022 13:13:35 +0100 Subject: [PATCH] docs: relocate source files from docs to docs/source --- .readthedocs.yaml | 6 +++--- README.md | 2 +- docs/Makefile | 2 +- docs/convenience/packages/theia.rst | 1 - docs/make.bat | 2 +- .../_static}/images/labextension-launcher.png | Bin docs/{ => source}/_static/images/logo/favicon.ico | Bin .../_static}/images/nbextension-tree.png | Bin docs/{ => source}/arbitrary-ports-hosts.rst | 0 docs/{ => source}/conf.py | 11 ++++------- docs/{ => source}/contributing/release.rst | 0 docs/{ => source}/convenience/new.rst | 0 docs/source/convenience/packages/theia.rst | 1 + docs/{ => source}/examples.rst | 0 docs/{ => source}/index.rst | 2 +- docs/{ => source}/install.rst | 0 docs/{ => source}/launchers.rst | 4 ++-- docs/{ => source}/server-process.rst | 0 18 files changed, 14 insertions(+), 17 deletions(-) delete mode 120000 docs/convenience/packages/theia.rst rename docs/{ => source/_static}/images/labextension-launcher.png (100%) rename docs/{ => source}/_static/images/logo/favicon.ico (100%) rename docs/{ => source/_static}/images/nbextension-tree.png (100%) rename docs/{ => source}/arbitrary-ports-hosts.rst (100%) rename docs/{ => source}/conf.py (92%) rename docs/{ => source}/contributing/release.rst (100%) rename docs/{ => source}/convenience/new.rst (100%) create mode 120000 docs/source/convenience/packages/theia.rst rename docs/{ => source}/examples.rst (100%) rename docs/{ => source}/index.rst (98%) rename docs/{ => source}/install.rst (100%) rename docs/{ => source}/launchers.rst (90%) rename docs/{ => source}/server-process.rst (100%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 70f903af..6bf99912 100644 --- 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 index e07e0f70..0fde5a52 100644 --- 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 index 5fd9d877..9d722500 100644 --- 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 deleted file mode 120000 index bbfbf844..00000000 --- a/docs/convenience/packages/theia.rst +++ /dev/null @@ -1 +0,0 @@ -../../../contrib/theia/README.rst \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat index ba30c170..49506420 100644 --- 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 b/docs/source/_static/images/labextension-launcher.png similarity index 100% rename from docs/images/labextension-launcher.png rename to docs/source/_static/images/labextension-launcher.png diff --git a/docs/_static/images/logo/favicon.ico b/docs/source/_static/images/logo/favicon.ico similarity index 100% rename from docs/_static/images/logo/favicon.ico rename to docs/source/_static/images/logo/favicon.ico diff --git a/docs/images/nbextension-tree.png b/docs/source/_static/images/nbextension-tree.png similarity index 100% rename from docs/images/nbextension-tree.png rename to docs/source/_static/images/nbextension-tree.png diff --git a/docs/arbitrary-ports-hosts.rst b/docs/source/arbitrary-ports-hosts.rst similarity index 100% rename from docs/arbitrary-ports-hosts.rst rename to docs/source/arbitrary-ports-hosts.rst diff --git a/docs/conf.py b/docs/source/conf.py similarity index 92% rename from docs/conf.py rename to docs/source/conf.py index 4ff5430f..89eb372f 100644 --- a/docs/conf.py +++ b/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 b/docs/source/contributing/release.rst similarity index 100% rename from docs/contributing/release.rst rename to docs/source/contributing/release.rst diff --git a/docs/convenience/new.rst b/docs/source/convenience/new.rst similarity index 100% rename from docs/convenience/new.rst rename to docs/source/convenience/new.rst diff --git a/docs/source/convenience/packages/theia.rst b/docs/source/convenience/packages/theia.rst new file mode 120000 index 00000000..49076d4b --- /dev/null +++ b/docs/source/convenience/packages/theia.rst @@ -0,0 +1 @@ +../../../../contrib/theia/README.rst \ No newline at end of file diff --git a/docs/examples.rst b/docs/source/examples.rst similarity index 100% rename from docs/examples.rst rename to docs/source/examples.rst diff --git a/docs/index.rst b/docs/source/index.rst similarity index 98% rename from docs/index.rst rename to docs/source/index.rst index 2397bb7e..1a884d47 100644 --- a/docs/index.rst +++ b/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 `_ for - `dask `_. + `dask `_. Contents diff --git a/docs/install.rst b/docs/source/install.rst similarity index 100% rename from docs/install.rst rename to docs/source/install.rst diff --git a/docs/launchers.rst b/docs/source/launchers.rst similarity index 90% rename from docs/launchers.rst rename to docs/source/launchers.rst index 7897fd13..c26340a9 100644 --- a/docs/launchers.rst +++ b/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 b/docs/source/server-process.rst similarity index 100% rename from docs/server-process.rst rename to docs/source/server-process.rst