Draft
Conversation
This commit includes the following changes:
- Updates `docs/API.rst` to include `automodule` directives for all enlopy modules: `analysis`, `generate`, `plot`, `stats`, and `utils`.
- Modifies `enlopy/stats.py` to change the usage of `scipy.signal.ricker` from a direct function import to a string literal ('ricker') for the `wavelet` parameter in `get_peaks`. This resolves an `autodoc` import issue that prevented the `stats` module from being documented.
- Includes the necessary Sphinx configuration files in the `docs` directory.
- The HTML documentation was successfully generated with these changes, ensuring all modules are picked up by `autodoc`.
Note: This addresses the initial setup and generation of the API reference. Further work is required to create comprehensive documentation, including rationales, use cases, and filling out all .rst files as per your feedback. The current documentation is primarily an API listing. Dependency issues with matplotlib==2.2.0 in docs/requirements.txt were noted; I used newer versions to generate the docs.
… done so far and provide feedback for Jules to continue.
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.
No description provided.