Repository navigation
Publish documentation on Read the Docs - #32
Merged
Merged
Conversation
rafatahmed
force-pushed
the
docs/readthedocs-site
branch
from
October 20, 2026 06:02
aac30fc to
aaba2a2
Compare
rafatahmed
added a commit
that referenced
this pull request
Nov 7, 2026
Publish documentation on Read the Docs
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
1 participant
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.
Publishes the reader-facing FlahaX docs at https://flahax.readthedocs.io/, built from a new
docs/site/folder with Sphinx 8.1.3, MyST 4.0.1 and the furo theme.What changes
docs/site/. Sections: User guide, For growers and agronomists, Models and chemistry, Evidence and audits, API reference, Changelog. Reader pages are moved withgit mv, so each page still has one source.USER_GUIDE.md,API_REFERENCE.mdandCHANGELOG.mdcome in through MyST{include}. Their cross-links are rewritten at build time, so the files in the package don't change.docs/*.mdlink in the v0.1.0–v0.4.0 READMEs and every old path named in shipped text (docstrings, CLI help, provenance strings). Each stub points to https://flahax.readthedocs.io/.docs/and are not on the site: roadmaps, status, release readiness, publishing, the landscape comparison and SWOT, design notes, history and schemas.docs/index.mdbecomes the maintainer index.docs/superpowers/is no longer in the repo. It's gitignored, untracked and pruned from the sdist..readthedocs.yamltreats warnings as errors and a new CIdocsjob runs the same build.tests/test_docs_site.pychecks the config, the pinned docs requirements, that nothing private ends up indocs/site/, and that the stubs exist.DocumentationURL inpyproject.tomlpoints to https://flahax.readthedocs.io/.docs/publishing.mdrecords the Read the Docs dashboard settings, and the changelog has an Unreleased line.No new scientific content. The grower page is new, and every statement on it comes from an existing docs page. The docs dependencies live only in
docs/site/requirements.txt, so flahax still has zero runtime dependencies.Verification
tests.test_docs_siteandtests.test_release_hygiene.sphinx -W --keep-goinggives zero warnings, also from a clean export with no local-only files.tools/verify_distribution.py,generate_api_reference.py --check,compileallandgit diff --check.After merge (owner)
latest=mainand turn PR previews on;v*automation rule from the next release;latestuntil then.README.mddoc links: update them to the site in a separate change.docs/landscape-comparison-swot.md:231: it links intodocs/superpowers/, so remove that link before committing pending edits to the file.