WIP: Get sphinx-multiproject working

gselzer · gselzer · commit 62862484e63b · 2023-12-11T13:35:29.000-06:00
diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml
@@ -4,17 +4,20 @@
 
 # Required
 version: 2
+build:
+   os: ubuntu-22.04
+   tools:
+      python: "3.11"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: doc/conf.py
+   configuration: docs/conf.py
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:
 #    - pdf
 
 # Optionally declare the Python requirements required to build your docs
 python:
-   version: 3.8
    install:
-   - requirements: doc/requirements.txt
+   - requirements: docs/requirements.txt
diff --git a/docs/Makefile b/docs/Makefile
@@ -6,7 +6,8 @@
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
-BUILDDIR      = _build
+PROJECT       ?= foo
+BUILDDIR      = _build/$(PROJECT)
 
 # Put it first so that "make" without argument is like "make help".
 help:
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,65 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- General configuration ---------------------------------------------------
+
+from multiproject.utils import get_project
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "multiproject",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx_search.extension",
+    "myst_nb",
+]
+
+
+multiproject_projects = {
+    "ops": {
+        "path": "ops/doc/",
+        "config": {
+            "project": "SciJava Ops documentation",
+            "html_title": "SciJava Ops documentation",
+        },
+    },
+}
+
+docset = get_project(multiproject_projects)
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    "README.md",
+    "examples/README.md",
+]
+
+# -- MyST-Parser/MyST-NB configuration ---------------------------------------
+myst_heading_anchors = 4
+nb_execution_mode = "off"
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []
+
diff --git a/docs/ops/doc/conf.py b/docs/ops/doc/conf.py
@@ -25,16 +25,6 @@
 
 # -- General configuration ---------------------------------------------------
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.viewcode",
-    "sphinx_search.extension",
-    "myst_nb",
-]
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -54,17 +44,6 @@
 nb_execution_mode = "off"
 
 # -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = "sphinx_rtd_theme"
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
-
 # Add the SciJava logo
 # html_logo = "doc-images/logo.svg"
 # html_theme_options = {
diff --git a/docs/ops/doc/requirements.txt b/docs/ops/doc/requirements.txt
diff --git a/docs/ops/environment.yml b/docs/ops/environment.yml
@@ -7,4 +7,5 @@ dependencies:
   - sphinx_rtd_theme
   - pip
   - pip:
+      - sphinx-multiproject
       - readthedocs-sphinx-search
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,4 @@
+sphinx-multiproject
+sphinx_rtd_theme
+myst-nb
+readthedocs-sphinx-search
