Docs - #10
Merged
Merged
Conversation
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.
This pull request sets up documentation building and hosting with MkDocs and Read the Docs, and improves the maintainability and usability of the documentation. The main changes include adding configuration files for Read the Docs and MkDocs, updating documentation dependencies, and refactoring internal links for better compatibility with the documentation site.
Documentation build and hosting setup:
.readthedocs.yamlto configure Read the Docs builds, specifying the OS, Python version, and requirements file for building the docs (.readthedocs.yaml).mkdocs.ymlto configure the MkDocs documentation site, including theme, navigation, plugins, and repository links (mkdocs.yml).docs/requirements.txtto specify documentation build dependencies (mkdocs-material,mkdocs-include-markdown-plugin) (docs/requirements.txt).Documentation content improvements:
docs/index.mdto reuse the repositoryREADME.mdas the documentation homepage, ensuring a single source of truth (docs/index.md).[Back to README](index.md)for internal navigation instead of relative paths, improving compatibility with the MkDocs site (multiple files). [1] [2] [3] [4] [5] [6] [7] [8] [9]Link and navigation fixes:
README.mdanddocs/testing.mdto point to the GitHub location, ensuring they work from both the docs site and repository (README.md,docs/testing.md). [1] [2]