From fcd51354e40437e93cb048a86a2faf206308d83b Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Fri, 21 Oct 2022 14:13:05 +0200 Subject: [PATCH] refactor: rename doc to docs, and adopt a docs/source folder --- .github/workflows/publish.yml | 4 ++-- .github/workflows/test.yml | 4 ++-- .readthedocs.yml | 2 +- CONTRIBUTING.md | 6 +++--- doc/contribute.md | 3 --- {doc => docs}/Makefile | 2 +- {doc => docs}/conf.py | 0 {doc => docs}/make.bat | 2 +- {doc => docs}/requirements.txt | 0 {doc => docs/source}/_static/custom.css | 0 .../source}/_static/images/architecture.png | Bin {doc => docs/source}/_static/images/favicon.png | Bin {doc => docs/source}/_static/images/logo.png | Bin {doc => docs/source}/_templates/navigation.html | 0 {doc => docs/source}/api.rst | 0 {doc => docs/source}/authentication.rst | 0 docs/source/contribute.md | 2 ++ {doc => docs/source}/cors.rst | 0 {doc => docs/source}/customization/index.rst | 0 {doc => docs/source}/customizing.rst | 0 {doc => docs/source}/debug.rst | 0 {doc => docs/source}/developer/index.rst | 0 {doc => docs/source}/developer/repoproviders.rst | 0 {doc => docs/source}/eventlogging.rst | 0 {doc => docs/source}/https.rst | 0 {doc => docs/source}/index.rst | 0 {doc => docs/source}/overview.rst | 0 {doc => docs/source}/reference/app.rst | 0 {doc => docs/source}/reference/build.rst | 0 {doc => docs/source}/reference/builder.rst | 0 {doc => docs/source}/reference/launcher.rst | 0 {doc => docs/source}/reference/main.rst | 0 {doc => docs/source}/reference/ref-index.rst | 0 {doc => docs/source}/reference/registry.rst | 0 {doc => docs/source}/reference/repoproviders.rst | 0 {doc => docs/source}/zero-to-binderhub/index.rst | 0 .../zero-to-binderhub/ovh/generate_id_details.png | Bin .../source}/zero-to-binderhub/ovh/new_project.png | Bin .../zero-to-binderhub/private-gitlab-repo-token.png | Bin .../zero-to-binderhub/private-repo-token.png | Bin .../source}/zero-to-binderhub/setup-binderhub.rst | 0 .../zero-to-binderhub/setup-prerequisites.rst | 0 .../source}/zero-to-binderhub/setup-registry.rst | 0 {doc => docs/source}/zero-to-binderhub/turn-off.rst | 0 helm-chart/binderhub/schema.yaml | 2 +- 45 files changed, 13 insertions(+), 14 deletions(-) delete mode 100644 doc/contribute.md rename {doc => docs}/Makefile (98%) rename {doc => docs}/conf.py (100%) rename {doc => docs}/make.bat (98%) rename {doc => docs}/requirements.txt (100%) rename {doc => docs/source}/_static/custom.css (100%) rename {doc => docs/source}/_static/images/architecture.png (100%) rename {doc => docs/source}/_static/images/favicon.png (100%) rename {doc => docs/source}/_static/images/logo.png (100%) rename {doc => docs/source}/_templates/navigation.html (100%) rename {doc => docs/source}/api.rst (100%) rename {doc => docs/source}/authentication.rst (100%) create mode 100644 docs/source/contribute.md rename {doc => docs/source}/cors.rst (100%) rename {doc => docs/source}/customization/index.rst (100%) rename {doc => docs/source}/customizing.rst (100%) rename {doc => docs/source}/debug.rst (100%) rename {doc => docs/source}/developer/index.rst (100%) rename {doc => docs/source}/developer/repoproviders.rst (100%) rename {doc => docs/source}/eventlogging.rst (100%) rename {doc => docs/source}/https.rst (100%) rename {doc => docs/source}/index.rst (100%) rename {doc => docs/source}/overview.rst (100%) rename {doc => docs/source}/reference/app.rst (100%) rename {doc => docs/source}/reference/build.rst (100%) rename {doc => docs/source}/reference/builder.rst (100%) rename {doc => docs/source}/reference/launcher.rst (100%) rename {doc => docs/source}/reference/main.rst (100%) rename {doc => docs/source}/reference/ref-index.rst (100%) rename {doc => docs/source}/reference/registry.rst (100%) rename {doc => docs/source}/reference/repoproviders.rst (100%) rename {doc => docs/source}/zero-to-binderhub/index.rst (100%) rename {doc => docs/source}/zero-to-binderhub/ovh/generate_id_details.png (100%) rename {doc => docs/source}/zero-to-binderhub/ovh/new_project.png (100%) rename {doc => docs/source}/zero-to-binderhub/private-gitlab-repo-token.png (100%) rename {doc => docs/source}/zero-to-binderhub/private-repo-token.png (100%) rename {doc => docs/source}/zero-to-binderhub/setup-binderhub.rst (100%) rename {doc => docs/source}/zero-to-binderhub/setup-prerequisites.rst (100%) rename {doc => docs/source}/zero-to-binderhub/setup-registry.rst (100%) rename {doc => docs/source}/zero-to-binderhub/turn-off.rst (100%) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index dd73bb2d72..d74a504f7e 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -5,7 +5,7 @@ on: paths-ignore: - "**.md" - "**.rst" - - "doc/**" + - "docs/**" - "examples/**" - ".github/workflows/**" - "!.github/workflows/publish.yml" @@ -13,7 +13,7 @@ on: 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 index ece22af4b2..906e97aafe 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -8,7 +8,7 @@ on: paths-ignore: - "**.md" - "**.rst" - - "doc/**" + - "docs/**" - "examples/**" - ".github/workflows/**" - "!.github/workflows/test.yml" @@ -16,7 +16,7 @@ on: paths-ignore: - "**.md" - "**.rst" - - "doc/**" + - "docs/**" - "examples/**" - ".github/workflows/**" - "!.github/workflows/test.yml" diff --git a/.readthedocs.yml b/.readthedocs.yml index e2777df682..d9edf8900c 100644 --- 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 index 4a363da9d5..b202d2a2d5 100644 --- 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 deleted file mode 100644 index 66c1f98d36..0000000000 --- a/doc/contribute.md +++ /dev/null @@ -1,3 +0,0 @@ -```{include} ../CONTRIBUTING.md - -``` diff --git a/doc/Makefile b/docs/Makefile similarity index 98% rename from doc/Makefile rename to docs/Makefile index 161dd44a56..22bfebce96 100644 --- a/doc/Makefile +++ b/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 b/docs/conf.py similarity index 100% rename from doc/conf.py rename to docs/conf.py diff --git a/doc/make.bat b/docs/make.bat similarity index 98% rename from doc/make.bat rename to docs/make.bat index 016294d93c..801c262e32 100644 --- a/doc/make.bat +++ b/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 b/docs/requirements.txt similarity index 100% rename from doc/requirements.txt rename to docs/requirements.txt diff --git a/doc/_static/custom.css b/docs/source/_static/custom.css similarity index 100% rename from doc/_static/custom.css rename to docs/source/_static/custom.css diff --git a/doc/_static/images/architecture.png b/docs/source/_static/images/architecture.png similarity index 100% rename from doc/_static/images/architecture.png rename to docs/source/_static/images/architecture.png diff --git a/doc/_static/images/favicon.png b/docs/source/_static/images/favicon.png similarity index 100% rename from doc/_static/images/favicon.png rename to docs/source/_static/images/favicon.png diff --git a/doc/_static/images/logo.png b/docs/source/_static/images/logo.png similarity index 100% rename from doc/_static/images/logo.png rename to docs/source/_static/images/logo.png diff --git a/doc/_templates/navigation.html b/docs/source/_templates/navigation.html similarity index 100% rename from doc/_templates/navigation.html rename to docs/source/_templates/navigation.html diff --git a/doc/api.rst b/docs/source/api.rst similarity index 100% rename from doc/api.rst rename to docs/source/api.rst diff --git a/doc/authentication.rst b/docs/source/authentication.rst similarity index 100% rename from doc/authentication.rst rename to docs/source/authentication.rst diff --git a/docs/source/contribute.md b/docs/source/contribute.md new file mode 100644 index 0000000000..ef6daa82aa --- /dev/null +++ b/docs/source/contribute.md @@ -0,0 +1,2 @@ +```{include} ../../CONTRIBUTING.md +``` diff --git a/doc/cors.rst b/docs/source/cors.rst similarity index 100% rename from doc/cors.rst rename to docs/source/cors.rst diff --git a/doc/customization/index.rst b/docs/source/customization/index.rst similarity index 100% rename from doc/customization/index.rst rename to docs/source/customization/index.rst diff --git a/doc/customizing.rst b/docs/source/customizing.rst similarity index 100% rename from doc/customizing.rst rename to docs/source/customizing.rst diff --git a/doc/debug.rst b/docs/source/debug.rst similarity index 100% rename from doc/debug.rst rename to docs/source/debug.rst diff --git a/doc/developer/index.rst b/docs/source/developer/index.rst similarity index 100% rename from doc/developer/index.rst rename to docs/source/developer/index.rst diff --git a/doc/developer/repoproviders.rst b/docs/source/developer/repoproviders.rst similarity index 100% rename from doc/developer/repoproviders.rst rename to docs/source/developer/repoproviders.rst diff --git a/doc/eventlogging.rst b/docs/source/eventlogging.rst similarity index 100% rename from doc/eventlogging.rst rename to docs/source/eventlogging.rst diff --git a/doc/https.rst b/docs/source/https.rst similarity index 100% rename from doc/https.rst rename to docs/source/https.rst diff --git a/doc/index.rst b/docs/source/index.rst similarity index 100% rename from doc/index.rst rename to docs/source/index.rst diff --git a/doc/overview.rst b/docs/source/overview.rst similarity index 100% rename from doc/overview.rst rename to docs/source/overview.rst diff --git a/doc/reference/app.rst b/docs/source/reference/app.rst similarity index 100% rename from doc/reference/app.rst rename to docs/source/reference/app.rst diff --git a/doc/reference/build.rst b/docs/source/reference/build.rst similarity index 100% rename from doc/reference/build.rst rename to docs/source/reference/build.rst diff --git a/doc/reference/builder.rst b/docs/source/reference/builder.rst similarity index 100% rename from doc/reference/builder.rst rename to docs/source/reference/builder.rst diff --git a/doc/reference/launcher.rst b/docs/source/reference/launcher.rst similarity index 100% rename from doc/reference/launcher.rst rename to docs/source/reference/launcher.rst diff --git a/doc/reference/main.rst b/docs/source/reference/main.rst similarity index 100% rename from doc/reference/main.rst rename to docs/source/reference/main.rst diff --git a/doc/reference/ref-index.rst b/docs/source/reference/ref-index.rst similarity index 100% rename from doc/reference/ref-index.rst rename to docs/source/reference/ref-index.rst diff --git a/doc/reference/registry.rst b/docs/source/reference/registry.rst similarity index 100% rename from doc/reference/registry.rst rename to docs/source/reference/registry.rst diff --git a/doc/reference/repoproviders.rst b/docs/source/reference/repoproviders.rst similarity index 100% rename from doc/reference/repoproviders.rst rename to docs/source/reference/repoproviders.rst diff --git a/doc/zero-to-binderhub/index.rst b/docs/source/zero-to-binderhub/index.rst similarity index 100% rename from doc/zero-to-binderhub/index.rst rename to docs/source/zero-to-binderhub/index.rst diff --git a/doc/zero-to-binderhub/ovh/generate_id_details.png b/docs/source/zero-to-binderhub/ovh/generate_id_details.png similarity index 100% rename from doc/zero-to-binderhub/ovh/generate_id_details.png rename to docs/source/zero-to-binderhub/ovh/generate_id_details.png diff --git a/doc/zero-to-binderhub/ovh/new_project.png b/docs/source/zero-to-binderhub/ovh/new_project.png similarity index 100% rename from doc/zero-to-binderhub/ovh/new_project.png rename to docs/source/zero-to-binderhub/ovh/new_project.png diff --git a/doc/zero-to-binderhub/private-gitlab-repo-token.png b/docs/source/zero-to-binderhub/private-gitlab-repo-token.png similarity index 100% rename from doc/zero-to-binderhub/private-gitlab-repo-token.png rename to docs/source/zero-to-binderhub/private-gitlab-repo-token.png diff --git a/doc/zero-to-binderhub/private-repo-token.png b/docs/source/zero-to-binderhub/private-repo-token.png similarity index 100% rename from doc/zero-to-binderhub/private-repo-token.png rename to docs/source/zero-to-binderhub/private-repo-token.png diff --git a/doc/zero-to-binderhub/setup-binderhub.rst b/docs/source/zero-to-binderhub/setup-binderhub.rst similarity index 100% rename from doc/zero-to-binderhub/setup-binderhub.rst rename to docs/source/zero-to-binderhub/setup-binderhub.rst diff --git a/doc/zero-to-binderhub/setup-prerequisites.rst b/docs/source/zero-to-binderhub/setup-prerequisites.rst similarity index 100% rename from doc/zero-to-binderhub/setup-prerequisites.rst rename to docs/source/zero-to-binderhub/setup-prerequisites.rst diff --git a/doc/zero-to-binderhub/setup-registry.rst b/docs/source/zero-to-binderhub/setup-registry.rst similarity index 100% rename from doc/zero-to-binderhub/setup-registry.rst rename to docs/source/zero-to-binderhub/setup-registry.rst diff --git a/doc/zero-to-binderhub/turn-off.rst b/docs/source/zero-to-binderhub/turn-off.rst similarity index 100% rename from doc/zero-to-binderhub/turn-off.rst rename to docs/source/zero-to-binderhub/turn-off.rst diff --git a/helm-chart/binderhub/schema.yaml b/helm-chart/binderhub/schema.yaml index f55ffd1dfe..a0b91a0efb 100644 --- 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.