-
Notifications
You must be signed in to change notification settings - Fork 22
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
Contributing to the documents #311
Comments
Leave this issue out, if there are no special requirements for sphinx 2.0.0. 🤓 |
I'm sure you are correct. I was mostly focused on development and not on contributions, so I expect some of the docs are too light in that regard. We should use CONTRIBUTING.md, and I currently use rst for docs since it's a bit more powerful than md (at least in Sphinx). |
Well done! Expect a more detailed development guideline! |
Another piece of advice for |
@henryiii , I think we should add more standards for Doc contributing (maybe to add something, e.g. contributing-doc.md or add a new title in CONTRIBUTING.md). When adding new docs, should contributors use
file.md
orfile.rst
? Where to put new files? What is the structure or format of the submitted document?I saw you have
"docs": ["Sphinx>=2.0.0", "recommonmark>=0.5.0", "sphinx_rtd_theme"]
in setup.py, so I think it's worth broadcasting this specification to other contributors.The text was updated successfully, but these errors were encountered: