Skip to content

[Enhancement]: requirements.txt is missing several Sphinx extensions used in conf.py #449

Description

@mayank2295

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

Contribution

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions