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

Maybe add contributing guidelines to readthedocs #3

Closed
cblegare opened this issue Oct 9, 2021 · 3 comments
Closed

Maybe add contributing guidelines to readthedocs #3

cblegare opened this issue Oct 9, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@cblegare
Copy link

cblegare commented Oct 9, 2021

Hello again!

May I suggest you add your nice contributor's guide to the read the docs? This can be done without duplicating the documentation's source:

  1. Convert (manually) CONTRIBUTING.md to RestructuredText as CONTRIBUTING.rst (Github will still render it just fine as HTML).

  2. Add a contributing.rst file to your doc and add it somewhere to the doctree with the following content:

.. _contributing:

.. include:: ../CONTRIBUTING.rst
  1. There is no third step!
@cblegare
Copy link
Author

cblegare commented Oct 9, 2021

I see you depend on the MyST parser for the docs, so you may not have to convert md -> rst. I also see it is only used to include the README.md in docs/index.md. One could prefer to simply convert README.md to README.rst an remove the MyST parser, Github will manage this just fine.

@OliverHofkens OliverHofkens added the documentation Improvements or additions to documentation label Oct 21, 2021
@OliverHofkens OliverHofkens self-assigned this Oct 21, 2021
@OliverHofkens
Copy link
Member

Thanks for the great suggestions, that sounds great!
I'm gonna try to reserve some time next friday to look at this and the other suggestions that have come up so far.

@OliverHofkens
Copy link
Member

This is now done and live with the newly released v0.4.2: https://odata-query.readthedocs.io/en/latest/contributing.html
One minor note: Pypi refuses packages with unparseable README's, so I had to remove the Sphinx :ref: to the contributing page there.
Thanks for helping us improve this package!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants