Moving from GitHub Pages to Read The Docs #32
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
There was a problem hiding this comment.
Pull Request Overview
This PR migrates the project's documentation hosting from GitHub Pages to Read The Docs by adding MkDocs configuration and Read The Docs build settings.
- Added MkDocs configuration with comprehensive navigation structure for users, developers, and appendices
- Added Read The Docs build configuration with Python 3.13 and Ubuntu 24.04
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| mkdocs.yml | Defines the complete MkDocs site configuration including navigation, theme, and markdown extensions |
| .readthedocs.yaml | Sets up Read The Docs build environment with Python 3.13 and MkDocs integration |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -0,0 +1,67 @@ | |||
| site_name: Hatch | |||
| site_description: Hatch is the package manager for the Hatch! ecosystem. | |||
| site_url: https://crackingshells.github.io/Hatch/ | |||
There was a problem hiding this comment.
The site_url still points to GitHub Pages (github.io) but this PR is migrating to Read The Docs. This should be updated to the Read The Docs URL format, typically https://{project-name}.readthedocs.io/.
Suggested change
| site_url: https://crackingshells.github.io/Hatch/ | |
| site_url: https://hatch.readthedocs.io/ |
LittleCoinCoin
pushed a commit
that referenced
this pull request
Sep 8, 2025
* Add Read the Docs configuration file * Add initial mkdocs configuration for documentation
LittleCoinCoin
pushed a commit
that referenced
this pull request
Sep 16, 2025
* Add Read the Docs configuration file * Add initial mkdocs configuration for documentation
cracking-shells-semantic-release bot
pushed a commit
that referenced
this pull request
Sep 16, 2025
## [0.7.0-dev.1](v0.6.2...v0.7.0-dev.1) (2025-09-16) ### Features * add wobble decorators to test_docker_installer.py ([66740f8](66740f8)) * add wobble decorators to test_env_manip.py ([ec6e0a2](ec6e0a2)) * add wobble decorators to test_online_package_loader.py ([34b8173](34b8173)) * add wobble decorators to test_python_environment_manager.py ([251b0d8](251b0d8)) * add wobble decorators to test_registry_retriever.py ([0bc43fe](0bc43fe)) * add wobble decorators to test_system_installer.py ([26707b5](26707b5)) * complete wobble test categorization ([5a11d45](5a11d45)) * implement self-contained test data architecture with 15 core packages ([c7a2fae](c7a2fae)) ### Bug Fixes * add missing wobble decorators to remaining test files ([e3a1c92](e3a1c92)) * add required scope parameters to integration test decorators ([ca9cf65](ca9cf65)) * correct wobble integration_test decorator usage ([faf3344](faf3344)) * migrate failing tests to use self-contained test packages ([33c5782](33c5782)) * resolve critical test failures in architecture migration ([c3c3575](c3c3575)) ### Documentation * add mkdocs-print-site-plugin ([#37](#37)) ([dd86960](dd86960)) * enable code copy feature in mkdocs.yml ([300c114](300c114)) * enable Python requirements installation for documentation build ([#35](#35)) ([ea53013](ea53013)) * enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([b99c964](b99c964)) * moving from GitHub Pages to Read The Docs ([#32](#32)) ([9b7dd07](9b7dd07)) * update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([5fd9a40](5fd9a40)) ### Code Refactoring * eliminate redundant dynamic test package generation ([f497c09](f497c09)) * remove sys.path.insert statements from test files ([41c291e](41c291e))
cracking-shells-semantic-release bot
pushed a commit
that referenced
this pull request
Sep 17, 2025
## [0.7.0-dev.1](v0.6.2...v0.7.0-dev.1) (2025-09-17) ### Features * add centralized test data infrastructure for non-TTY testing ([a704937](a704937)) * add non-TTY handling to dependency installation orchestrator ([ee63d6e](ee63d6e)) * add wobble decorators to test_docker_installer.py ([66740f8](66740f8)) * add wobble decorators to test_env_manip.py ([ec6e0a2](ec6e0a2)) * add wobble decorators to test_online_package_loader.py ([34b8173](34b8173)) * add wobble decorators to test_python_environment_manager.py ([251b0d8](251b0d8)) * add wobble decorators to test_registry_retriever.py ([0bc43fe](0bc43fe)) * add wobble decorators to test_system_installer.py ([26707b5](26707b5)) * complete wobble test categorization ([5a11d45](5a11d45)) * implement self-contained test data architecture with 15 core packages ([c7a2fae](c7a2fae)) ### Bug Fixes * add missing wobble decorators to remaining test files ([e3a1c92](e3a1c92)) * add required scope parameters to integration test decorators ([ca9cf65](ca9cf65)) * correct wobble integration_test decorator usage ([faf3344](faf3344)) * migrate failing tests to use self-contained test packages ([33c5782](33c5782)) * resolve critical test failures in architecture migration ([c3c3575](c3c3575)) ### Documentation * add comprehensive documentation for non-TTY handling ([65c1efb](65c1efb)) * add mkdocs-print-site-plugin ([#37](#37)) ([dd86960](dd86960)) * enable code copy feature in mkdocs.yml ([300c114](300c114)) * enable Python requirements installation for documentation build ([#35](#35)) ([ea53013](ea53013)) * enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([b99c964](b99c964)) * moving from GitHub Pages to Read The Docs ([#32](#32)) ([9b7dd07](9b7dd07)) * update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([5fd9a40](5fd9a40)) ### Code Refactoring * eliminate redundant dynamic test package generation ([f497c09](f497c09)) * remove sys.path.insert statements from test files ([41c291e](41c291e))
cracking-shells-semantic-release bot
pushed a commit
that referenced
this pull request
Sep 18, 2025
## [0.7.0-dev.1](v0.6.2...v0.7.0-dev.1) (2025-09-18) ### Features * add centralized test data infrastructure for non-TTY testing ([a704937](a704937)) * add non-TTY handling to dependency installation orchestrator ([ee63d6e](ee63d6e)) * add wobble decorators to test_docker_installer.py ([66740f8](66740f8)) * add wobble decorators to test_env_manip.py ([ec6e0a2](ec6e0a2)) * add wobble decorators to test_online_package_loader.py ([34b8173](34b8173)) * add wobble decorators to test_python_environment_manager.py ([251b0d8](251b0d8)) * add wobble decorators to test_registry_retriever.py ([0bc43fe](0bc43fe)) * add wobble decorators to test_system_installer.py ([26707b5](26707b5)) * complete wobble test categorization ([5a11d45](5a11d45)) * implement self-contained test data architecture with 15 core packages ([c7a2fae](c7a2fae)) ### Bug Fixes * add missing wobble decorators to remaining test files ([e3a1c92](e3a1c92)) * add required scope parameters to integration test decorators ([ca9cf65](ca9cf65)) * correct wobble integration_test decorator usage ([faf3344](faf3344)) * migrate failing tests to use self-contained test packages ([33c5782](33c5782)) * resolve critical test failures in architecture migration ([c3c3575](c3c3575)) ### Documentation * add comprehensive documentation for non-TTY handling ([65c1efb](65c1efb)) * add mkdocs-print-site-plugin ([#37](#37)) ([dd86960](dd86960)) * enable code copy feature in mkdocs.yml ([300c114](300c114)) * enable Python requirements installation for documentation build ([#35](#35)) ([ea53013](ea53013)) * enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([b99c964](b99c964)) * moving from GitHub Pages to Read The Docs ([#32](#32)) ([9b7dd07](9b7dd07)) * update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([5fd9a40](5fd9a40)) ### Code Refactoring * eliminate redundant dynamic test package generation ([f497c09](f497c09)) * remove sys.path.insert statements from test files ([41c291e](41c291e))
cracking-shells-semantic-release bot
pushed a commit
that referenced
this pull request
Sep 18, 2025
## [0.7.0](v0.6.2...v0.7.0) (2025-09-18) ### Features * add centralized test data infrastructure for non-TTY testing ([a704937](a704937)) * add non-TTY handling to dependency installation orchestrator ([ee63d6e](ee63d6e)) * add wobble decorators to test_docker_installer.py ([66740f8](66740f8)) * add wobble decorators to test_env_manip.py ([ec6e0a2](ec6e0a2)) * add wobble decorators to test_online_package_loader.py ([34b8173](34b8173)) * add wobble decorators to test_python_environment_manager.py ([251b0d8](251b0d8)) * add wobble decorators to test_registry_retriever.py ([0bc43fe](0bc43fe)) * add wobble decorators to test_system_installer.py ([26707b5](26707b5)) * complete wobble test categorization ([5a11d45](5a11d45)) * implement self-contained test data architecture with 15 core packages ([c7a2fae](c7a2fae)) ### Bug Fixes * add missing wobble decorators to remaining test files ([e3a1c92](e3a1c92)) * add required scope parameters to integration test decorators ([ca9cf65](ca9cf65)) * correct wobble integration_test decorator usage ([faf3344](faf3344)) * migrate failing tests to use self-contained test packages ([33c5782](33c5782)) * resolve critical test failures in architecture migration ([c3c3575](c3c3575)) ### Documentation * add comprehensive documentation for non-TTY handling ([65c1efb](65c1efb)) * add mkdocs-print-site-plugin ([#37](#37)) ([dd86960](dd86960)) * enable code copy feature in mkdocs.yml ([300c114](300c114)) * enable Python requirements installation for documentation build ([#35](#35)) ([ea53013](ea53013)) * enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([b99c964](b99c964)) * moving from GitHub Pages to Read The Docs ([#32](#32)) ([9b7dd07](9b7dd07)) * update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([5fd9a40](5fd9a40)) ### Code Refactoring * eliminate redundant dynamic test package generation ([f497c09](f497c09)) * remove sys.path.insert statements from test files ([41c291e](41c291e))
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.
No description provided.