-
-
Notifications
You must be signed in to change notification settings - Fork 253
Description
Type of Enhancement
Adding/improving 'Further Reading' resources
Relevant Page(s) URL (if applicable)
https://discover-cookbook.numfocus.org/#versions
Current Content Snippet (Optional, but helpful)
requirements.txt is missing several Sphinx extensions used in conf.py
Proposed Enhancement / Suggestion
Update the requirements.txt file to include all Sphinx extensions currently used in conf.py. Several required dependencies are missing, which can lead to build errors and confusion for contributors. Adding these dependencies will make the setup process smoother, more reliable, and beginner-friendly.
Rationale & Expected Impact
This enhancement is valuable because the current requirements.txt file does not list several Sphinx extensions that are actively used in conf.py. As a result, new contributors, maintainers, or anyone trying to build the documentation locally may encounter build errors, missing features, or confusing warnings.
By explicitly adding all required dependencies, the setup process becomes more reliable, predictable, and beginner-friendly. It reduces friction for first-time contributors and ensures that the documentation builds consistently across different environments.
Additional Resources / Further Reading
- Sphinx documentation: https://www.sphinx-doc.org/
- Jupyter Book documentation: https://jupyterbook.org/
- sphinx-copybutton: https://sphinx-copybutton.readthedocs.io/
- sphinx-design: https://sphinx-design.readthedocs.io/
- sphinx-togglebutton: https://sphinx-togglebutton.readthedocs.io/
- sphinx-book-theme: https://sphinx-book-theme.readthedocs.io/
Contribution
- I agree to follow the DISCOVER Cookbook's Code of Conduct and Contributing Guidelines.
- I would be willing to draft a pull request to implement this enhancement.