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 info on documentation to CONTRIBUTING.rst #1500
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this would surely be helpful :)
One suggestion:
this does not cover windows. On there, you need to run sphinx-build docs\source temp_html or so :) |
Right, forgot about that. I'm using Windows, and I have installed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
uhm, there exists requirements-docs.txt in the docs folder, which people need to install with pip -r. Sorry that I only think of that now ;P
I didn't find this information elsewhere in the repository; I thought it might be useful for new contributors.
Ha! I also missed that. I've added it now. |
Hi, |
I didn't find this information elsewhere in the repository; I thought it might be useful for new contributors.