Skip to content

Conversation

@mayank2295
Copy link

Description of Changes

This PR addresses #449 by adding all Sphinx extensions used in
conf.py to both requirements.txt and environment.yml

Changes:

Added sphinx-togglebutton
Added sphinx-copybutton
Added sphinx-design
Added sphinx-book-theme
Added sphinx-jupyterbook-latex
Added sphinx-multitoc-numbering
Testing:

Built the book locally with sphinx-build.

Copilot AI review requested due to automatic review settings January 13, 2026 17:22
@netlify
Copy link

netlify bot commented Jan 13, 2026

Deploy Preview for stupendous-kringle-a86e81 failed.

Name Link
🔨 Latest commit eee2fcb
🔍 Latest deploy log https://app.netlify.com/projects/stupendous-kringle-a86e81/deploys/696680c7973fd50008178099

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR addresses issue #449 by adding missing Sphinx extensions to the project's dependency files. The extensions were already being used in conf.py but were not explicitly listed in the requirements, which could cause build failures in clean environments.

Changes:

  • Added six Sphinx extensions to requirements.txt and environment.yml
  • Added version constraint (>=1.0.0) to jupyter-book dependency

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.

File Description
requirements.txt Added six Sphinx extensions (sphinx-togglebutton, sphinx-copybutton, sphinx-design, sphinx-book-theme, sphinx-jupyterbook-latex, sphinx-multitoc-numbering) and version constraint for jupyter-book
environment.yml Added the same six Sphinx extensions and version constraint for jupyter-book to maintain consistency with requirements.txt

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mayank2295
Copy link
Author

Hi! 👋

I would like to work on this issue. I've already analyzed the codebase and identified all the missing dependencies.

Here's my plan:

  1. Update requirements.txt with all Sphinx extensions used in conf.py:

    • sphinx-togglebutton
    • sphinx-copybutton
    • sphinx-design
    • sphinx-book-theme
    • sphinx-jupyterbook-latex
    • sphinx-multitoc-numbering
  2. Update environment.yml to stay in sync with requirements.txt

  3. Add version pinning for jupyter-book>=1.0.0 to ensure compatibility

  4. Test locally by building the book with sphinx-build

I've already updated environment.yml locally and tested it. I'll submit a PR shortly.

Could you please assign this issue to me? This is my first open source contribution and I'm excited to help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant