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

idea: rewrite main readme and release file to .rst, import into docs #221

Open
deargle opened this issue Mar 4, 2021 · 5 comments · Fixed by #222
Open

idea: rewrite main readme and release file to .rst, import into docs #221

deargle opened this issue Mar 4, 2021 · 5 comments · Fixed by #222

Comments

@deargle
Copy link
Collaborator

deargle commented Mar 4, 2021

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.

@sauln
Copy link
Member

sauln commented Mar 4, 2021

Sounds great!

@deargle
Copy link
Collaborator Author

deargle commented Mar 5, 2021

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.

@sauln
Copy link
Member

sauln commented Mar 6, 2021

We do have the link to the link to the documentation in the about section in the righthand pane on github. You think that would be sufficient enough to remove the reference in the readme?

@deargle deargle reopened this Mar 8, 2021
@deargle
Copy link
Collaborator Author

deargle commented Mar 8, 2021

I missed that. Yes, I think that would be sufficient.

Are you okay with adding a new dependency to the docs build? m2r2 would permit us to import a markdown README.md into sphinx (it converts it to rst).

@sauln
Copy link
Member

sauln commented Mar 8, 2021

Sure! dependencies for docs are easy since to users have to concern themselves with it.

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

Successfully merging a pull request may close this issue.

2 participants