Skip to content

Create documentation and host at readthedocs.io#3

Merged
DakotaHester merged 8 commits intomainfrom
docs
Jul 13, 2025
Merged

Create documentation and host at readthedocs.io#3
DakotaHester merged 8 commits intomainfrom
docs

Conversation

@DakotaHester
Copy link
Collaborator

Documentation created using sphinx and hosted at pcxarray.readthedocs.io. No tests here, but have verified documentation is well-formatted and up-to-date.

@DakotaHester DakotaHester self-assigned this Jul 13, 2025
@DakotaHester DakotaHester requested a review from Copilot July 13, 2025 06:40
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.toml and 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_collections lacks 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/
Copy link

Copilot AI Jul 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/

Copilot uses AI. Check for mistakes.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@DakotaHester DakotaHester merged commit 27a5fc6 into main Jul 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants