Cleaning up lots of things in the documentation#94
Merged
Conversation
…ke a local version of the documentation when testing.
There was a problem hiding this comment.
Pull request overview
This pull request performs extensive documentation cleanup for the ECT package. The changes include:
Changes:
- Enhanced docstrings across multiple source files (results.py, embed_complex.py, directions.py, dect.py) with improved formatting, examples, and detailed parameter descriptions
- Removed outdated Tutorial-ExactECT from the tutorial list (addresses issue #73)
- Updated Sphinx configuration to properly locate source modules
- Added
html-localtarget in Makefile for local documentation building - Removed generated documentation HTML files from the docs folder
- Deleted unused Extra_Notebooks/Mesh.ipynb
- Updated .gitignore to exclude docs_local and .vscode directories
- Updated contributing guidelines with correct documentation build instructions
Reviewed changes
Copilot reviewed 57 out of 153 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/ect/results.py | Added comprehensive docstrings for ECTResult class methods including plot, smooth, dist, save_npz, load_npz |
| src/ect/embed_complex.py | Added detailed docstrings for properties and methods; added functools import for decorator |
| src/ect/ect.py | Simplified class docstring, removed redundant Attributes section |
| src/ect/directions.py | Enhanced docstrings with proper formatting and examples |
| src/ect/dect.py | Added detailed docstrings for DECT class methods |
| src/ect/validation/validator.py | Minor whitespace cleanup |
| doc_source/conf.py | Fixed sys.path configuration, removed unsupported display_version option |
| doc_source/tutorials.rst | Removed Tutorial-ExactECT reference |
| doc_source/embed_complex.md | Changed autodoc flags to :no-index: |
| doc_source/contributing.rst | Updated with correct documentation build instructions |
| Makefile | Added html-local target for local documentation generation |
| .gitignore | Added docs_local and .vscode |
| Extra_Notebooks/Mesh.ipynb | Removed unused notebook |
| docs/* | Removed all generated HTML documentation files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| (\text{num\_dir}, \text{num\_thresh}) | ||
|
|
||
| Notes: | ||
| - The DECT is computed as a sum over all simplices, using a sigmoid function $\sigma(x) = \frac{1}{1 + e^{-x}}$ to smoothly count contributions above each threshold. |
There was a problem hiding this comment.
The math notation uses $...$ delimiters which is LaTeX/Markdown syntax, but the docstring is likely being processed by Sphinx which expects reStructuredText. The math should be enclosed in :math: role syntax like :math:\sigma(x) = \frac{1}{1 + e^{-x}}`` or in a math directive block which is already used above. Mixed notation styles may cause rendering issues in the documentation.
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.
Pull Request
Summary
So much documentation cleanup. Got rid of unused old jupyter notebooks, plus got the autocompiler to find all the docstrings from the files.
Description
Motivation and Context
How has this been tested?
Nothing should break, this should only have affected docstrings and thus the documentation.
Types of changes
Checklist
make clean)pyproject.tomlfile (if applicable).make tests)pyproject.toml.Additional Notes
Screenshots (if applicable)