Cleaning up lots of things in the documentation

[lizliz]

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.

• Closes reproduce manuscript example & debug Tutorial 3.2 #73 since that was a sandbox jupyter notebook that should have been taken down.

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

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Code refactoring
• Performance improvement
• Test improvement

Checklist

• My code follows the code style of this project. (make clean)
• I have incremented the version number in the pyproject.toml file (if applicable).
• I have added tests to cover my changes (if applicable).
• All new and existing tests passed. (make tests)
• I have updated the documentation (if applicable).
• My changes generate no new warnings.
• I have added any necessary new dependencies to pyproject.toml.

Additional Notes

Screenshots (if applicable)

[Copilot]

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-local target 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.

[Copilot]

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.

[yemeen]

LGTM!!