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

Make READMEs visible #25

Open
eccles opened this issue Sep 2, 2021 · 2 comments
Open

Make READMEs visible #25

eccles opened this issue Sep 2, 2021 · 2 comments

Comments

@eccles
Copy link
Member

eccles commented Sep 2, 2021

Is your feature request related to a problem? Please describe.
Each sample has a README.md file detailing the use-case. This is not currently visible without cloning the REPO.

Describe the solution you'd like
Convert READMEs to ReStructured text and use the include:: directive to make each README visible to anyone who access the github repo in Github. (unfortunately markdown does not have this capability).

Describe alternatives you've considered
Additionally we could use sphinx to generate documentation (not from source code) and publish to gh-pages at python-samples.rkvst.com.

@eccles eccles changed the title Make README's visible Make READMEs visible Sep 2, 2021
@eccles
Copy link
Member Author

eccles commented Sep 14, 2021

Some experimentation with converting READMEs to rst shows that the include and toctree options do not work as envisaged. Howver adding Sphinx documentation in the same way as other repos and publishing to gh-pages will work.

@JAG-UK
Copy link
Contributor

JAG-UK commented Sep 14, 2021

The READMEs are visible in the repo page on GitHub. GH web automatically renders README.md for any directory you’re browsing.

You don’t need to clone the repo to see it: you just have to visit 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

No branches or pull requests

2 participants