Enhance documentation and add demo notebook for PyDS library #48
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
- Updated `requirements.txt` to include `nbsphinx` and `sphinx-copybutton` for improved documentation support. - Modified `conf.py` to integrate `nbsphinx` and `sphinx_copybutton` extensions, along with configuration options for notebook execution and error handling. - Updated `index.rst` to include a new table of contents for the PyDS demo notebook. - Added a new `notebooks/demo.ipynb` file demonstrating the complete machine learning workflow using the PyDS library. - Created a symlink in `docs/source/notebooks` to reference the demo notebook location.
- Added new lexers to `requirements.txt` for enhanced syntax highlighting support in documentation. - Updated `conf.py` to include additional autodoc mock imports for improved documentation generation.
- Included `apt-get install pandoc` in the GitHub Actions workflow for documentation to ensure necessary dependencies are available for building documentation.
- Changed the installation command for pandoc in the GitHub Actions workflow from `apt-get install pandoc` to `sudo apt-get install pandoc` to ensure proper permissions during installation.
- Included `sudo apt-get install pandoc` in the GitHub Actions workflow to ensure proper permissions during installation of documentation dependencies.
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.
requirements.txtto includenbsphinxandsphinx-copybuttonfor improved documentation support.conf.pyto integratenbsphinxandsphinx_copybuttonextensions, along with configuration options for notebook execution and error handling.index.rstto include a new table of contents for the PyDS demo notebook.notebooks/demo.ipynbfile demonstrating the complete machine learning workflow using the PyDS library.docs/source/notebooksto reference the demo notebook location.pandocto as a dependency in GitHub workflow for docs.Description
Fix #(issue)
Type of change
Please check the option that is related to your PR.
Checklist
lint.shand ensure that it passes (Use./lint.sh --fixto fix formatting issues automatically)