Skip to content

Use README.md to write index.rst in documentation #11

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

Open
bobleesj opened this issue Aug 12, 2024 · 1 comment
Open

Use README.md to write index.rst in documentation #11

bobleesj opened this issue Aug 12, 2024 · 1 comment

Comments

@bobleesj
Copy link
Contributor

The original README.md before cookiecutting has lots of useful information while there is no index.rst provided in the documentation.

We shall use the information to write the index.rst file.

@bobleesj bobleesj changed the title Use READMD.md to write index.rst in documentation Use README.md to write index.rst in documentation Aug 12, 2024
@sbillinge
Copy link
Contributor

yes, please do take care of blending the info from the old EADME.md into the new README.rst, and also as you mention, this can be reused in the docs and the long_description in pypi/conda-forge

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

No branches or pull requests

2 participants