Add comprehensive Sphinx-compatible documentation #117
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 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.
|
Should there be a github action workflow with this to build the site? |
|
Also getting some feedback that no one, even sphinx users write in rst anymore. Could we target md (markdown instead)? Could also consider using mkdocs which is the popular current choice. Since Claude was used to do this, shouldn't be a big lift to change. |
maap/maap.py
Outdated
| algorithm_description: Process satellite data | ||
| docker_container_url: registry/image:tag | ||
| script_command: python run.py | ||
| algorithm_params: |
Member
There was a problem hiding this comment.
algorithm_params field instead needs to be
inputs:
config: []
file: []
positional: []
maap/maap.py
Outdated
| ... 'algorithm_description': 'Processes satellite data', | ||
| ... 'docker_container_url': 'registry/image:tag', | ||
| ... 'script_command': 'python run.py', | ||
| ... 'algorithm_params': [ |
Member
There was a problem hiding this comment.
algorithm_params instead needs to be "inputs": {'file': [{"name":"test"}], "config": [{"name":"test"}], "positional": [{"name":"test"}]}
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/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.
Contributor
Author
|
Addressed comments, please check again. |
grallewellyn
approved these changes
Dec 11, 2025
wildintellect
approved these changes
Dec 18, 2025
wildintellect
left a comment
wildintellect
left a comment
There was a problem hiding this comment.
Great, let's merge this and generate the website so we can see how it looks.
sujen1412
deleted the
claude/document-maap-py-library-01FDnRcUZGCLgBgdFGpzy2a5
branch
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.
Add NumPy-style docstrings to all main modules:
Create Sphinx documentation structure:
Update package init.py with module-level documentation
Documentation follows NumPy docstring format compatible with Sphinx autodoc and napoleon extensions for API documentation generation.
Github Issue: #44