docs: publish documentation as a GitHub Pages site (Sphinx)#37
Merged
Conversation
Turn the existing-but-unbuilt Sphinx setup into a real, searchable docs site that
deploys on every push to main.
- .github/workflows/docs.yml: build the Sphinx HTML (`-W --keep-going`, so doc
regressions fail the build) and deploy to GitHub Pages. Build also runs on PRs
(validation); only main/manual runs deploy.
- conf.py: read the version from the package (no more stale hard-coded release);
exclude docs/README.md (it's the folder meta-index, mirrors index.md).
- index.md becomes the master doc with a `{toctree}` (sidebar nav); removed the
duplicate index.rst that conflicted with it.
- Fixed cross-tree Markdown links (../.github/*, ../ml/README, ../README, ../LICENSE)
to absolute GitHub URLs so they resolve both on github.com and in the Sphinx site
— clears all the myst xref warnings; the build is now warning-clean.
- pyproject "Documentation" URL + a README docs badge/link point to the Pages site.
One-time setup the maintainer must do: repo Settings -> Pages -> Source: "GitHub
Actions". After that the site goes live at
https://guillain-rdcde.github.io/FLAC_Detective/ on the next push to main.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
…on CI Empty dirs aren't tracked by git, so a fresh CI checkout lacked docs/_static, making Sphinx warn 'html_static_path entry _static does not exist' — fatal under -W. Add .gitkeep to both _static and _templates (referenced by conf.py). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…-import) CodeQL flagged 'from ...__version__ import __version__ as release' as an unused import (Sphinx only reads 'release' as a module global, never references it), and a noqa silences flake8 but not CodeQL. Import the module and assign the attribute instead — the import is now clearly used and 'release' is a plain config global. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#3 — Site de documentation GitHub Pages (Sphinx)
Transforme le setup Sphinx (présent mais jamais buildé) en un vrai site de docs navigable et searchable, déployé à chaque push sur
main.Ce que ça apporte
.github/workflows/docs.yml: build du HTML Sphinx (-W --keep-going→ toute régression doc casse le build) + déploiement GitHub Pages. Le build tourne aussi sur les PR (validation) ; seulmain/manuel déclenche le deploy.conf.py: version lue depuis le package (fini lesreleasepérimés codés en dur) ;docs/README.mdexclu (méta-index, doublon d'index.md).index.mddevient le doc maître avec une{toctree}(nav latérale) ; suppression duindex.rsten double qui entrait en conflit.../.github/*,../ml/README,../README,../LICENSE→ URLs absolues GitHub) : résolvent sur github.com et dans le site Sphinx → build 100% sans warning.Build local validé
sphinx-build -W --keep-going→ exit 0, 0 warning, 8 pages générées (index, getting-started, user-guide, api-reference, technical-details, roadmap-formats, genindex, search).Repo Settings → Pages → Source : « GitHub Actions ». Ensuite le site est en ligne à https://guillain-rdcde.github.io/FLAC_Detective/ dès le prochain push sur
main.🤖 Generated with Claude Code