Add infrastructure for project docs (#68)

* Add infrastructure for project docs

* Add dummy logos

* Add jupyterlite-sphinx deployment

* Add .readthedocs.yaml

* Fix relative link

* Debug

* Update readme with how to build and server docs

Author: ianthomas23

.github/workflows/build.yml

@@ -188,3 +188,5 @@ jobs:
       - uses: actions/checkout@v4
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
+        with:
+          ignore_glob: docs/*.md

.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: mambaforge-23.11
+  jobs:
+    pre_build:
+      - pip install -v .
+
+conda:
+  environment: docs/environment-docs.yml
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true

README.md

@@ -119,6 +119,25 @@ or:
 jupyter lite serve --LiteBuildConfig.extra_http_headers=Cross-Origin-Embedder-Policy=require-corp --LiteBuildConfig.extra_http_headers=Cross-Origin-Opener-Policy=same-origin
 ```
 
+### Building the documentation
+
+The project documentation includes a demo deployment, and is built on every PR so that the changes can be checked manually before merging. To build the documentation and demo locally use:
+
+```bash
+micromamba create -f docs/environment-docs.yml
+micromamba activate terminal-docs
+pip install -v .
+cd docs
+make html
+```
+
+To serve this locally use:
+
+```bash
+cd _build/html
+python -m http.server
+```
+
 ### Packaging the extension
 
 See [RELEASE](RELEASE.md)

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/terminal_logo_dark.svg

@@ -0,0 +1 @@
+../CHANGELOG.md

docs/_static/terminal_logo_light.svg

@@ -0,0 +1,37 @@
+from datetime import date
+import json
+from pathlib import Path
+
+PACKAGE_JSON_FILENAME = Path(__file__).parent.parent / "package.json"
+PACKAGE_JSON = json.loads(PACKAGE_JSON_FILENAME.read_text(encoding="utf-8"))
+
+project = 'JupyterLite Terminal'
+author = PACKAGE_JSON["author"]["name"]
+copyright = f"2024-{date.today().year}, {author}"
+release = PACKAGE_JSON["version"]
+
+extensions = [
+    "jupyterlite_sphinx",
+    "myst_parser"
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+html_static_path = ['_static']
+html_theme = "pydata_sphinx_theme"
+html_theme_options = {
+    "github_url": PACKAGE_JSON["homepage"],
+    "logo": {
+        "alt_text": "JupyterLite Terminal - Home",
+        "image_dark": "_static/terminal_logo_dark.svg",
+        "image_light": "_static/terminal_logo_light.svg",
+        "text": "JupyterLite Terminal",
+   }
+}
+html_title = "JupyterLite Terminal"
+
+# jupyterlite_sphonx settings
+jupyterlite_contents = "../deploy/contents/"
+jupyterlite_dir = "../deploy/"
+jupyterlite_silence = False

docs/changelog.md

@@ -0,0 +1,17 @@
+name: terminal-docs
+channels:
+  - conda-forge
+dependencies:
+  # General build dependencies
+  - micromamba
+  - nodejs =20
+  - python =3.13
+
+  # Jupyter dependencies
+  - jupyterlite-core >=0.6,<0.8.0
+
+  # Docs dependencies
+  - jupyterlite-sphinx
+  - myst-parser
+  - pydata-sphinx-theme
+  - sphinx

docs/conf.py

@@ -0,0 +1,13 @@
+# JupyterLite Terminal
+
+Blah blah blah.
+
+## Contents
+
+```{toctree}
+:maxdepth: 1
+
+changelog
+```
+
+Link to <a href="./lite">deployment</a>.