-
Notifications
You must be signed in to change notification settings - Fork 183
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
idea: rewrite main readme and release file to .rst, import into docs #221
Comments
Sounds great! |
I'm not sure this is a good idea anymore. On the github readme, we want to have a link to the documentation. But if we use the github readme as the documentation index page, then that means the documentation has a link to itself at the top, potentially making people think they're not already looking at the documentation. I did do a small DRY where I'm just linking to the doc's "how to cite" section instead of repeating the how-to-cite info in the github readme. |
We do have the link to the link to the documentation in the |
I missed that. Yes, I think that would be sufficient. Are you okay with adding a new dependency to the docs build? |
Sure! dependencies for docs are easy since to users have to concern themselves with it. |
We can use sphinx to DRY use the repo's README as the index page for the docs., if we rewrite the readme to be .rst instead of .md. Same for RELEASE.txt -- we can have it rendered as a docs page. I'll open a PR with the same as part of getting ready for 2.0.0 unless you're opposed.
The text was updated successfully, but these errors were encountered: