Repository navigation
Conversation
The docs were scaffolded from an earlier cookieplone-templates docs starter and carried Read the Docs configuration with an unfilled placeholder slug. - Toolchain: align docs/pyproject.toml, docs/Makefile and docs/docs/conf.py with the current starter. Remove the rtd-* targets, the Read the Docs README section and docs/.readthedocs.yaml. Allow Python up to 3.14 for the docs project and regenerate docs/uv.lock. - Point the OpenSearch, sitemap and robots.txt URLs at the GitHub Pages site. Fix the theme repository and edit URLs that pointed at a wrong repository name. - Remove the Read the Docs path filter from the CI configuration. - Revise the pages to the Plone documentation style and organize them by Diataxis section. Add a first-document tutorial, the how-to index, the reference index, and CLI and HTTP service reference pages. Document HTML and Markdown input for the Python API, the CLI and the HTTP service. - Fix the glossary, the Vale vocabulary and the examples that did not run. Refs #43
The docs and docs-deploy jobs in main.yml now pass python-version 3.14. The other jobs keep the default from config.yml. Refs #43
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
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.
The documentation was scaffolded from an earlier version of the
cookieplone-templatesdocs starter and had drifted from it. It still carried Read the Docs configuration with an unfilledMY_READTHEDOCS_PROJECT_SLUGplaceholder, although the docs are built and published to GitHub Pages bydocs-deploy.yml.This PR brings the documentation up to the current standard:
docs/follows the current docs starter (pyproject.toml,Makefile,conf.py, Vale configuration), and the docs build runs on Python 3.14 like the package..readthedocs.yaml, thertd-*Makefile targets, the README section and the CI path filter are gone. The OpenSearch, sitemap androbots.txtURLs now point to the GitHub Pages site.The docs jobs in
main.yml(docsanddocs-deploy) now run on Python 3.14, while the other jobs keep the 3.12 default fromconfig.yml. The theme repository links and the edit path inconf.pypointed at a wrong repository name,collectivehtml2blocksdocumentation; they now point atcollective/collective.html2blocks. The CLI and HTTP service details moved from the how-to pages into new reference pages, and the how-to pages link to them.Closes #43