Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add python requirements file for the sphinx docs? #132

Open
mukul1992 opened this issue Jul 3, 2024 · 1 comment
Open

Add python requirements file for the sphinx docs? #132

mukul1992 opened this issue Jul 3, 2024 · 1 comment

Comments

@mukul1992
Copy link
Contributor

In my experience, installing the python package requirements for compiling the sphinx docs had to be done manually and was cumbersome. For instance, I believe the breathe package does not work with the most recent versions of sphinx. But there might be other dependency issues too while I hacked through it. Additionally some of the sphinx extensions are not installed automatically and had to be added manually while compiling.

I believe there is a practice to add a "requirements.txt" file in such cases for users to easily install the required dependencies. Should we add something like that, or are there other solutions? Of course this would be needed only for contributors to the documentation and not for regular users of the code.

If that seems like a good solution, I will attempt to prepare a minimal requirements file that is able to compile the docs successfully, as time permits.

@cgilet
Copy link
Collaborator

cgilet commented Jul 3, 2024

I think anything that lowers the barrier to adding documentation is a good idea! I'd be happy for you to do this.

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

No branches or pull requests

2 participants