Sinc #162
Merged
Sinc #162
Conversation
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
This commit adds extensive documentation to the `eegdash` repository. - Adds NumPy-style docstrings to all public functions, methods, and classes across all modules and sub-packages. - Clarifies the purpose, parameters, and return values for all documented code.
Merge pull request #153 from sccn/develop last details about the documentation
This commit adds a time estimation feature for all tutorials in the documentation. This is achieved by creating a custom Sphinx extension that calculates the median reading time for each tutorial and displays it at the top of the page. The following changes were made: - Created a new Sphinx extension `sphinx_time_estimation.py` to calculate the reading time. - Created a new module `custom_gallery.py` to override the default `sphinx-gallery` behavior and display the reading time. - Modified `docs/source/conf.py` to include the new extension and module. - Fixed the build errors and verified that the changes are working as expected.
This commit adds a time estimation feature for all tutorials in the documentation. This is achieved by creating a custom Sphinx extension that calculates the median reading time for each tutorial and displays it at the top of the page. The following changes were made: - Created a new Sphinx extension `sphinx_time_estimation.py` to calculate the reading time. - Created a new module `custom_gallery.py` to override the default `sphinx-gallery` behavior and display the reading time. - Modified `docs/source/conf.py` to include the new extension and module. - Fixed the build errors and verified that the changes are working as expected.
This commit refactors the time estimation feature to use Sphinx's templating system instead of monkey-patching `sphinx-gallery`. This approach is more robust and maintainable. The following changes were made: - Removed the `custom_gallery.py` file and the corresponding import from `conf.py`. - Updated `sphinx_time_estimation.py` to correctly traverse the `doctree` and exclude code blocks from the word count. - Created a new `page.html` template to display the estimated reading time. - Corrected reStructuredText formatting in tutorial files to resolve build errors.
Fixing dark theme
[DOC] Add time estimation for tutorials
Add Comprehensive Codebase Documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.