Skip to content

Make READMEs visible #25

@eccles

Description

@eccles

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions