You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
eccles
changed the title
Make README's visible
Make READMEs visible
Sep 2, 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.
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.
The text was updated successfully, but these errors were encountered: