From d688eaba841f068c94c3ec1ab49590c404a4e6fb Mon Sep 17 00:00:00 2001 From: goodboy Date: Sat, 27 Jun 2026 20:26:19 -0400 Subject: [PATCH] Prime the docs for GitHub Pages serving The gh-pages deploy workflow already exists (build on PR + main, deploy on main push via `actions/deploy-pages`); wire up the sphinx side, - `sphinx.ext.githubpages`: emits a `.nojekyll` so Pages serves the `_static/` + `_images/` dirs (Jekyll otherwise drops `_`-prefixed paths, breaking every asset), - `html_baseurl`: the canonical site root (`https://goodboy.github.io/tractor/`) for the `` + `og:url` tags. The one remaining (one-time, manual) step is the repo setting: Settings -> Pages -> Source = "GitHub Actions". (this patch was generated in some part by [`claude-code`][claude-code-gh]) [claude-code-gh]: https://github.com/anthropics/claude-code --- docs/conf.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index f7e68fc5..c446551b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,6 +41,10 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', 'sphinx.ext.todo', + # emit a `.nojekyll` so GitHub Pages serves the `_static/` + # + `_images/` dirs (Jekyll would otherwise drop `_`-prefixed + # paths and break all styling/assets). + 'sphinx.ext.githubpages', 'sphinx_design', 'sphinx_copybutton', 'sphinxext.opengraph', @@ -93,6 +97,9 @@ intersphinx_mapping = { html_theme = 'pydata_sphinx_theme' html_title = 'tractor' +# canonical site root (GitHub Pages); drives , +# og:url + any future sitemap. Update if a custom domain is added. +html_baseurl = 'https://goodboy.github.io/tractor/' html_logo = '_static/tractor_logo_side.svg' html_favicon = '_static/tractor_logo_side.svg' html_static_path = ['_static']