refactor: rename doc to docs, and adopt a docs/source folder

jupyterhub · Oct 21, 2022 · fcd5135 · fcd5135
1 parent 326d6e2
commit fcd5135
Show file tree

Hide file tree

Showing 45 changed files with 13 additions and 14 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -5,15 +5,15 @@ on:
     paths-ignore:
       - "**.md"
       - "**.rst"
-      - "doc/**"
+      - "docs/**"
       - "examples/**"
       - ".github/workflows/**"
       - "!.github/workflows/publish.yml"
   push:
     paths-ignore:
       - "**.md"
       - "**.rst"
-      - "doc/**"
+      - "docs/**"
       - "examples/**"
       - ".github/workflows/**"
       - "!.github/workflows/publish.yml"

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -8,15 +8,15 @@ on:
     paths-ignore:
       - "**.md"
       - "**.rst"
-      - "doc/**"
+      - "docs/**"
       - "examples/**"
       - ".github/workflows/**"
       - "!.github/workflows/test.yml"
   push:
     paths-ignore:
       - "**.md"
       - "**.rst"
-      - "doc/**"
+      - "docs/**"
       - "examples/**"
       - ".github/workflows/**"
       - "!.github/workflows/test.yml"

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -14,4 +14,4 @@ build:
 
 python:
   install:
-    - requirements: doc/requirements.txt
+    - requirements: docs/requirements.txt
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -32,13 +32,13 @@ language](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
 1. Install BinderHub and the documentation tools:
 
    ```bash
-   python3 -m pip install -r doc/requirements.txt
+   python3 -m pip install -r docs/requirements.txt
    ```
 
-1. The documentation is located in the `doc/` sub-directory, `cd` into it:
+1. The documentation is located in the `docs/` sub-directory, `cd` into it:
 
    ```bash
-   cd ./doc
+   cd ./docs
    ```
 
 1. To build the documentation run:

diff --git a/doc/contribute.md b/doc/contribute.md
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
@@ -5,7 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?= -W
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
+SOURCEDIR     = source
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".

diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
diff --git a/doc/make.bat → docs/make.bat b/doc/make.bat → docs/make.bat
@@ -10,7 +10,7 @@ if "%SPHINXOPTS%" == "" (
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=.
+set SOURCEDIR=source
 set BUILDDIR=_build
 
 if "%1" == "" goto help

diff --git a/doc/requirements.txt → docs/requirements.txt b/doc/requirements.txt → docs/requirements.txt
diff --git a/doc/_static/custom.css → docs/source/_static/custom.css b/doc/_static/custom.css → docs/source/_static/custom.css
diff --git a/doc/_static/images/architecture.png → docs/source/_static/images/architecture.png b/doc/_static/images/architecture.png → docs/source/_static/images/architecture.png
diff --git a/doc/_static/images/favicon.png → docs/source/_static/images/favicon.png b/doc/_static/images/favicon.png → docs/source/_static/images/favicon.png
diff --git a/doc/_static/images/logo.png → docs/source/_static/images/logo.png b/doc/_static/images/logo.png → docs/source/_static/images/logo.png
diff --git a/doc/_templates/navigation.html → docs/source/_templates/navigation.html b/doc/_templates/navigation.html → docs/source/_templates/navigation.html
diff --git a/doc/api.rst → docs/source/api.rst b/doc/api.rst → docs/source/api.rst
diff --git a/doc/authentication.rst → docs/source/authentication.rst b/doc/authentication.rst → docs/source/authentication.rst
diff --git a/docs/source/contribute.md b/docs/source/contribute.md
@@ -0,0 +1,2 @@
+```{include} ../../CONTRIBUTING.md
+```
diff --git a/doc/cors.rst → docs/source/cors.rst b/doc/cors.rst → docs/source/cors.rst
diff --git a/doc/customization/index.rst → docs/source/customization/index.rst b/doc/customization/index.rst → docs/source/customization/index.rst
diff --git a/doc/customizing.rst → docs/source/customizing.rst b/doc/customizing.rst → docs/source/customizing.rst
diff --git a/doc/debug.rst → docs/source/debug.rst b/doc/debug.rst → docs/source/debug.rst
diff --git a/doc/developer/index.rst → docs/source/developer/index.rst b/doc/developer/index.rst → docs/source/developer/index.rst
diff --git a/doc/developer/repoproviders.rst → docs/source/developer/repoproviders.rst b/doc/developer/repoproviders.rst → docs/source/developer/repoproviders.rst
diff --git a/doc/eventlogging.rst → docs/source/eventlogging.rst b/doc/eventlogging.rst → docs/source/eventlogging.rst
diff --git a/doc/https.rst → docs/source/https.rst b/doc/https.rst → docs/source/https.rst
diff --git a/doc/index.rst → docs/source/index.rst b/doc/index.rst → docs/source/index.rst
diff --git a/doc/overview.rst → docs/source/overview.rst b/doc/overview.rst → docs/source/overview.rst
diff --git a/doc/reference/app.rst → docs/source/reference/app.rst b/doc/reference/app.rst → docs/source/reference/app.rst
diff --git a/doc/reference/build.rst → docs/source/reference/build.rst b/doc/reference/build.rst → docs/source/reference/build.rst
diff --git a/doc/reference/builder.rst → docs/source/reference/builder.rst b/doc/reference/builder.rst → docs/source/reference/builder.rst
diff --git a/doc/reference/launcher.rst → docs/source/reference/launcher.rst b/doc/reference/launcher.rst → docs/source/reference/launcher.rst
diff --git a/doc/reference/main.rst → docs/source/reference/main.rst b/doc/reference/main.rst → docs/source/reference/main.rst
diff --git a/doc/reference/ref-index.rst → docs/source/reference/ref-index.rst b/doc/reference/ref-index.rst → docs/source/reference/ref-index.rst
diff --git a/doc/reference/registry.rst → docs/source/reference/registry.rst b/doc/reference/registry.rst → docs/source/reference/registry.rst
diff --git a/doc/reference/repoproviders.rst → docs/source/reference/repoproviders.rst b/doc/reference/repoproviders.rst → docs/source/reference/repoproviders.rst
diff --git a/doc/zero-to-binderhub/index.rst → docs/source/zero-to-binderhub/index.rst b/doc/zero-to-binderhub/index.rst → docs/source/zero-to-binderhub/index.rst
diff --git a/...-to-binderhub/ovh/generate_id_details.png → ...-to-binderhub/ovh/generate_id_details.png b/...-to-binderhub/ovh/generate_id_details.png → ...-to-binderhub/ovh/generate_id_details.png
diff --git a/doc/zero-to-binderhub/ovh/new_project.png → ...rce/zero-to-binderhub/ovh/new_project.png b/doc/zero-to-binderhub/ovh/new_project.png → ...rce/zero-to-binderhub/ovh/new_project.png
diff --git a/...o-binderhub/private-gitlab-repo-token.png → ...o-binderhub/private-gitlab-repo-token.png b/...o-binderhub/private-gitlab-repo-token.png → ...o-binderhub/private-gitlab-repo-token.png
diff --git a/doc/zero-to-binderhub/private-repo-token.png → .../zero-to-binderhub/private-repo-token.png b/doc/zero-to-binderhub/private-repo-token.png → .../zero-to-binderhub/private-repo-token.png
diff --git a/doc/zero-to-binderhub/setup-binderhub.rst → ...rce/zero-to-binderhub/setup-binderhub.rst b/doc/zero-to-binderhub/setup-binderhub.rst → ...rce/zero-to-binderhub/setup-binderhub.rst
diff --git a/...zero-to-binderhub/setup-prerequisites.rst → ...zero-to-binderhub/setup-prerequisites.rst b/...zero-to-binderhub/setup-prerequisites.rst → ...zero-to-binderhub/setup-prerequisites.rst
diff --git a/doc/zero-to-binderhub/setup-registry.rst → ...urce/zero-to-binderhub/setup-registry.rst b/doc/zero-to-binderhub/setup-registry.rst → ...urce/zero-to-binderhub/setup-registry.rst
diff --git a/doc/zero-to-binderhub/turn-off.rst → docs/source/zero-to-binderhub/turn-off.rst b/doc/zero-to-binderhub/turn-off.rst → docs/source/zero-to-binderhub/turn-off.rst
diff --git a/helm-chart/binderhub/schema.yaml b/helm-chart/binderhub/schema.yaml
@@ -4,7 +4,7 @@
 #
 # This schema is also used by our documentation system to build the
 # configuration reference section based on the description fields. See
-# doc/source/conf.py for that logic!
+# docs/source/conf.py for that logic!
 #
 # We look to document everything we have default values for in values.yaml, but
 # we don't look to enforce the perfect validation logic within this file.