Merge pull request #1565 from consideRatio/pr/docs-maintenance

docs: add devenv and linkcheck to Makefile and misc details

Author: minrk

.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"

.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"

.gitignore

@@ -1,16 +1,45 @@
+# Manually added parts to .gitignore
+# ----------------------------------
+#
+
+# OS Stuff
+.DS_Store
+
+# Node stuff
+node_modules/
+package-lock.json
+
+# Built files
+binderhub/static/dist
+helm-chart/binderhub/charts
+helm-chart/binderhub/requirements.lock
+testing/k8s-binder-k8s-hub/binderhub-chart-config-remote.yaml
+ci/id_rsa
+
+# Instructions we download
+k8s.txt
+helm.txt
+
+# Federation data page
+docs/federation/data-federation.txt
+
+# Editors etc
+.vscode/
+
+
+# Python .gitignore from https://github.com/github/gitignore/blob/HEAD/Python.gitignore
+# -------------------------------------------------------------------------------------
+#
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class
 
 # C extensions
 *.so
-.idea
-.pytest_cache
 
 # Distribution / packaging
 .Python
-env/
 build/
 develop-eggs/
 dist/
@@ -22,9 +51,13 @@ lib64/
 parts/
 sdist/
 var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+MANIFEST
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -39,14 +72,16 @@ pip-delete-this-directory.txt
 # Unit test / coverage reports
 htmlcov/
 .tox/
+.nox/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
 coverage.xml
-*,cover
+*.cover
+*.py,cover
 .hypothesis/
-/http-record.*.json
+.pytest_cache/
 
 # Translations
 *.mo
@@ -55,6 +90,8 @@ coverage.xml
 # Django stuff:
 *.log
 local_settings.py
+db.sqlite3
+db.sqlite3-journal
 
 # Flask stuff:
 instance/
@@ -69,49 +106,56 @@ docs/_build/
 # PyBuilder
 target/
 
-# IPython Notebook
+# Jupyter Notebook
 .ipynb_checkpoints
 
+# IPython
+profile_default/
+ipython_config.py
+
 # pyenv
 .python-version
 
-# celery beat schedule file
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
 celerybeat-schedule
+celerybeat.pid
 
-# dotenv
-.env
+# SageMath parsed files
+*.sage.py
 
-# virtualenv
+# Environments
+.env
+.venv
+env/
 venv/
 ENV/
+env.bak/
+venv.bak/
 
 # Spyder project settings
 .spyderproject
+.spyproject
 
 # Rope project settings
 .ropeproject
 
-# OS Stuff
-.DS_Store
-
-# Sphinx stuff
-_build/
+# mkdocs documentation
+/site
 
-# Node stuff
-node_modules/
-package-lock.json
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
 
-# Built files
-binderhub/static/dist
-helm-chart/binderhub/charts
-helm-chart/binderhub/requirements.lock
-testing/k8s-binder-k8s-hub/binderhub-chart-config-remote.yaml
-ci/id_rsa
-
-# Instructions we download
-k8s.txt
-helm.txt
-
-# Federation data page
-doc/federation/data-federation.txt
-.vscode/
+# Pyre type checker
+.pyre/

.readthedocs.yaml

@@ -0,0 +1,17 @@
+# Configuration on how ReadTheDocs (RTD) builds our documentation
+# ref: https://readthedocs.org/projects/binderhub/
+# ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
+#
+version: 2
+
+sphinx:
+  configuration: docs/source/conf.py
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: docs/requirements.txt