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

De-duplicate README content #222

Open
matt-graham opened this issue Sep 26, 2024 · 0 comments
Open

De-duplicate README content #222

matt-graham opened this issue Sep 26, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@matt-graham
Copy link
Collaborator

Currently there is some duplication of content across the top-level README.md file, the index.rst file used as the documentation site index page and the .pip_readme.rst file used in the packages PyPI index page, which runs the risk of one or more getting of date / out of sync with each other.

It's possible to include Markdown files in a Sphinx site using either extensions like https://github.com/omnilib/sphinx-mdinclude and https://myst-parser.readthedocs.io/en/v0.17.2/sphinx/intro.html so we could potentially include the top-level README.md in the Sphinx docs and also use this as a direct replacement for the .pip_readme.rst file by just pointing to this file in pyproject.toml once #173 is merged.

@matt-graham matt-graham added the documentation Improvements or additions to documentation label Sep 26, 2024
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

1 participant