Docs/api documentation update for release-3.1.0#202
Open
jeipollack wants to merge 135 commits intodevelopfrom
Open
Docs/api documentation update for release-3.1.0#202jeipollack wants to merge 135 commits intodevelopfrom
jeipollack wants to merge 135 commits intodevelopfrom
Conversation
…ean up submodule docs, update conf.py, and update pyproject.toml version
- Removed old auto-generated wf_psf.rst from _autosummary - Updated toc.rst (fixed tab issues, reference api.rst) - Added api.rst with :recursive: directive and wf_psf.run entrypoint - Refined __init__.py docstrings for all subpackages for clarity and consistency - Updated module-level docstrings (purpose, authors, TensorFlow notes, etc.)
- Shorten sections to make developer-friendly - Added new structure for each section: Purppose, Key Fields, Notes, General Notes, etc, where applicable - Partial completion - new PR is required to verify optional versus required settings
…odels and tf_modules, add/rm modules, update import statements and tests
…it test due to refactoring
…ods and variable names|
…o statement and comment
…les, update import statements and unit tests
…ess datasets and update docstrings
- Updated classes and methods with complete doc strings - Added two cache clearing methods to PSFInference and PSFInferenceEngine classes
Rebase dropped commits that removed weights_path from the metrics interface. Cleaning up remaining references in docstrings and tests.
Use f-strings instead of %-formatting to properly display percent symbols in metric output.
- Remove tensorflow-addons from environment.yml file - Remove simulation parameters from example data_config.yaml file - Naming consistency - rename inference configuration YAML file - Improve inline comments in example metrics, plotting and training configuration files - Update pyproject.toml with setup tools to ensure all packages are found by sphinx autosummary - Remove tensorflow from autodoc_mock_imports list - Add docstring to conf.py - Add scriv fragment describing internal changes
- Add API documentation for new inference and instrument packages - Restructure configuration documentation: * Split workflows into CLI tasks vs standalone components * Add configuration file dependency table * Document inference_config.yaml * Clarify filename flexibility and standardize section structure - Document tensorflow-addons as optional dependency - Fix bullet point rendering and ruff errors in data_handler.py and data_zernike_utils.py docstrings - Update example configuration files with clearer inline comments
jeipollack
changed the title
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
2 participants
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
Updates API documentation for the v3.1.0 release, adding documentation for new inference and instrument packages, restructuring configuration documentation for clarity, and documenting tensorflow-addons as an optional dependency.
What's changed
inferenceandinstrumentpackages inapi.rstconfiguration.md):inference_config.yamldependencies.mdto documenttensorflow-addonsas optional dependency with manual installation instructionsdata_handler.pyanddata_zernike_utils.pydocstringsHow to test / verify
cd docs make clean make htmlinferenceandinstrumentpackages appear in API documentationdata_handleranddata_zernike_utilsAPI pagesScope
This PR is part of the v3.1.0 release milestone.
Changelog
changelog.d/20260213_143539_jennifer.pollack_api_documentation_update.md)Reviewer Checklist
develop, ormainfor release PRs)ruff)Next Steps / Notes (if applicable)
Documentation has been verified to build and deploy correctly in a fork. The manual CD workflow improvements ensure proper artifact handling for future documentation deployments.