Create documentation and host at readthedocs.io#3
Merged
DakotaHester merged 8 commits intomainfrom Jul 13, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive Sphinx-based documentation for pcxarray and configures hosting on ReadTheDocs.
- Introduces Sphinx configuration files, requirements, RST modules, and Makefiles for building docs.
- Updates code docstrings and type hints for consistency and completeness.
- Adds development dependencies to
pyproject.tomland updates examples and README badges.
Reviewed Changes
Copilot reviewed 26 out of 33 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/pcxarray/utils.py | Expanded crs type hint, added default value and updated docstring formatting. |
| src/pcxarray/query.py | Reformatted docstrings, added get_pc_collections function with docs. |
| src/pcxarray/processing.py | Introduced Literal types for merge methods and cleaned up docstring punctuation. |
| src/pcxarray/io.py | Reflowed docstrings and standardized default argument formatting. |
| src/pcxarray/cache.py | Reformatted docstrings for consistency. |
| pyproject.toml | Added Sphinx and related packages to the dev dependencies. |
| docs/ | Added Sphinx conf, RST files, requirements, and build scripts. |
| examples/*.ipynb | Added markdown title cells and bumped notebook metadata versions. |
| README.md | Updated documentation links, badges, and example workflow badge. |
| .readthedocs.yml | Configured ReadTheDocs build settings. |
Comments suppressed due to low confidence (1)
src/pcxarray/query.py:176
- New public function
get_pc_collectionslacks any corresponding tests. Adding unit tests will ensure correct behavior when listing and filtering STAC collections.
def get_pc_collections(reduced: bool = True, crs: Union[CRS, str, int] = 4326) -> gpd.GeoDataFrame:
Comment on lines
+15
to
+22
| echo. | ||
| echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | ||
| echo.installed, then set the SPHINXBUILD environment variable to point | ||
| echo.to the full path of the 'sphinx-build' executable. Alternatively you | ||
| echo.may add the Sphinx directory to PATH. | ||
| echo. | ||
| echo.If you don't have Sphinx installed, grab it from | ||
| echo.https://www.sphinx-doc.org/ |
There was a problem hiding this comment.
In a Windows batch file, "echo.installed" prints ".installed" rather than the intended message. Add a space after echo (e.g., echo installed, ...) for each echo line.
Suggested change
| echo. | |
| echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | |
| echo.installed, then set the SPHINXBUILD environment variable to point | |
| echo.to the full path of the 'sphinx-build' executable. Alternatively you | |
| echo.may add the Sphinx directory to PATH. | |
| echo. | |
| echo.If you don't have Sphinx installed, grab it from | |
| echo.https://www.sphinx-doc.org/ | |
| echo. | |
| echo The 'sphinx-build' command was not found. Make sure you have Sphinx | |
| echo installed, then set the SPHINXBUILD environment variable to point | |
| echo to the full path of the 'sphinx-build' executable. Alternatively you | |
| echo may add the Sphinx directory to PATH. | |
| echo. | |
| echo If you don't have Sphinx installed, grab it from | |
| echo https://www.sphinx-doc.org/ |
Collaborator
Author
There was a problem hiding this comment.
Not committing as make.bat was generated by sphinx, may be something to look into in the future if building on Windows becomes necessary.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Documentation created using sphinx and hosted at pcxarray.readthedocs.io. No tests here, but have verified documentation is well-formatted and up-to-date.