Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #56 +/- ##
=======================================
Coverage 94.26% 94.26%
=======================================
Files 27 27
Lines 1848 1848
=======================================
Hits 1742 1742
Misses 106 106 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Add custom reset function to automatically reset all curvelets submodules between gallery examples, ensuring clean state.
- Remove intermediate api_reference.rst file - Update index.rst to reference api/modules.rst directly - Simplify sphinx-apidoc command in noxfile - Update Makefile doc target to use cleandoc - Update cleandoc to remove docs/api instead of docs/source
- Add new api/modules.rst file with proper toctree structure - Update index.rst to reference api/modules without .rst extension - Improve GitHub Discussion link text in contributing.rst for clarity - Add :no-index: directives to UDCT property docstrings to exclude from index
- Add new api/modules.rst file with proper toctree structure - Update index.rst to reference api/modules without .rst extension - Improve GitHub Discussion link text in contributing.rst for clarity - Add :no-index: directives to UDCT property docstrings to exclude from index
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
1 participant
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.
Note
Refactors documentation generation and structure for clarity and reliability.
docs/apiand update flows:Makefiledoc/cleandoctargets, andnoxfile.pybuild_api_docs(simplifiedsphinx-apidocflags); update index to useAPI <api/modules>docs/contributing.rst) and link it from the homepagereset_curvelets_modulesand set viasetup()to avoid caching/pickling issues; keep gallery config while deferringreset_modulesassignmentmodules.rsttitle tocurvelets, remove explicitUDCTModuleautoclass)curvelets.torch.UDCTproperty docstrings with:no-index:to reduce API surfaceWritten by Cursor Bugbot for commit 5b8f4ff. This will update automatically on new commits. Configure here.