Add Comprehensive Sphinx-Compatible Documentation #118
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
* Add comprehensive Sphinx-compatible documentation - Add NumPy-style docstrings to all main modules: - maap.py: Core MAAP client class with all methods documented - Result.py: Result, Granule, and Collection classes - dps_job.py: DPSJob class for job management - Profile.py: User profile management - AWS.py: AWS credential management - Secrets.py: User secrets management - config_reader.py: Configuration management - Create Sphinx documentation structure: - docs/conf.py: Sphinx configuration with Napoleon for NumPy docstrings - docs/index.rst: Main documentation index - docs/api/*.rst: API reference pages for all modules - Update package __init__.py with module-level documentation Documentation follows NumPy docstring format compatible with Sphinx autodoc and napoleon extensions for API documentation generation. * Fix algorithm registration docs to use correct inputs structure Update registerAlgorithm and register_algorithm_from_yaml_file docstrings to use the correct 'inputs' structure with 'file', 'config', and 'positional' arrays instead of the deprecated 'algorithm_params' format. Addresses PR review comments from grallewellyn. * Add GitHub Actions workflow and convert docs to Markdown - Add .github/workflows/docs.yml for automated doc building and deployment to GitHub Pages - Convert all .rst documentation files to Markdown format - Add MyST parser to Sphinx configuration for Markdown support - Add docs/requirements.txt with sphinx, sphinx-rtd-theme, myst-parser - Add docs/Makefile for local doc builds Addresses PR feedback from wildintellect requesting GitHub Actions workflow and Markdown format instead of reStructuredText. * algorithm_params to inputs in last spot --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: grallewellyn <grace.llewellyn@jpl.nasa.gov>
|
Looks like the build failed on outdated SONARCube version. |
Contributor
Author
|
Can we merge this to a version of the docs out ? @wildintellect @grallewellyn |
wildintellect
approved these changes
Jan 7, 2026
grallewellyn
approved these changes
Jan 7, 2026
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.
Summary
This PR adds comprehensive API documentation for the maap-py library, enabling auto-generated documentation that can be published to a website. This addresses Issue #44.
Key Changes
Changes
Documentation Content (Docstrings)
maap/maap.pysearchGranule,searchCollection,submitJob,registerAlgorithm, etc.)maap/Result.pyResult,Granule, andCollectionclasses with all data access methodsmaap/dps/dps_job.pyDPSJobclass with status polling, metrics, and job managementmaap/AWS.pymaap/Profile.pyProfileclass for user account informationmaap/config_reader.pyMaapConfigclass and environment variablesmaap/__init__.pySphinx Infrastructure
docs/conf.pydocs/index.mddocs/api/*.mddocs/requirements.txtsphinx,sphinx-rtd-theme,myst-parser)docs/MakefileCI/CD
.github/workflows/docs.ymlStats
Closes #44 (Auto generate docs)