Replace MkDocs docs site with Great Docs#26
Merged
Conversation
Migrate the documentation site from MkDocs + Material to Great Docs (https://posit-dev.github.io/great-docs/), a Quarto-based docs generator for Python packages. - Add great-docs.yml with branding, authors, user-guide ordering, and an API reference covering pdf_reader and the pdfminer/pytesseract parsers - Move guide content into user_guide/*.qmd (parsers, multiprocessing, spaCy extensions, changelog, contributing); convert MkDocs admonitions to Quarto callouts. The landing page is generated from README.md, so the old docs/hooks.py README-copy trick is no longer needed - Add .github/workflows/docs.yml to build and deploy to GitHub Pages on every push to main (uv sync --all-extras so the pytesseract parser can be introspected) - Remove mkdocs.yml, the docs/ directory, and the mkdocs/mkdocstrings dev dependencies; refresh uv.lock - Update justfile (preview-docs/build-docs via uvx), CLAUDE.md, and the changelog project URL Great Docs runs via uvx (Python 3.11+) so it stays separate from the package's own Python 3.9+ dependency floor. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012GMFfCNP6RbewDcAKDbmf5
Configure prek (pre-commit reimplementation) via prek.toml with ruff, rumdl, and basic file-check hooks. Add prek to the dev dependency group and document hook setup in the contributing guide and CLAUDE.md.
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.
Migrate the documentation site from MkDocs + Material to Great Docs
(https://posit-dev.github.io/great-docs/), a Quarto-based docs generator
for Python packages.
API reference covering pdf_reader and the pdfminer/pytesseract parsers
spaCy extensions, changelog, contributing); convert MkDocs admonitions
to Quarto callouts. The landing page is generated from README.md, so the
old docs/hooks.py README-copy trick is no longer needed
every push to main (uv sync --all-extras so the pytesseract parser can
be introspected)
dependencies; refresh uv.lock
changelog project URL
Great Docs runs via uvx (Python 3.11+) so it stays separate from the
package's own Python 3.9+ dependency floor.
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_012GMFfCNP6RbewDcAKDbmf5