Conversation
Add complete project documentation using MkDocs with the Material theme, configured for ReadTheDocs hosting. Pages: - Home: project overview, output figure example, usage summary - Installation: pip/conda/dev/GUI/notebook install instructions - Getting Started: quick examples for CLI, Python API, and web GUI - CLI Reference: full flag reference for ql, read_tls, rank_tls - Web GUI: job queue, each-sector mode, batch submission, gallery - Pipeline Overview: step-by-step pipeline description and explanation of all 9 diagnostic panels - API Reference: TessQuickLook constructor, attributes, methods, exceptions, and utility functions - Batch Processing: shell scripts, GNU parallel, post-processing with read_tls and rank_tls - FAQ: common errors, troubleshooting, parameter tuning Config: - mkdocs.yml with Material theme (light/dark toggle), code copy, admonitions, and tabbed content - .readthedocs.yaml fixed (typo on line 1) and updated to install docs/requirements.txt - docs/requirements.txt pins mkdocs, mkdocs-material, pymdown-extensions - .gitignore updated to exclude site/ build output Co-Authored-By: Claude Opus 4.6 <[email protected]>
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.
Add complete project documentation using MkDocs with the Material theme, configured for ReadTheDocs hosting.
Pages:
Config: