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.

Sign up for GitHub

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

Jump to bottom

Publish docs #145

Open
jeffa5 opened this issue Oct 31, 2022 · 0 comments
Open

Publish docs #145

jeffa5 opened this issue Oct 31, 2022 · 0 comments
Labels
automation Work on the repo automation documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jeffa5
Copy link
Collaborator

jeffa5 commented Oct 31, 2022

Is your feature request related to a problem? Please describe.

Currently the docs are not published, we should probably publish them to github pages. Switching to .rst from .md and using sphinx would be nice too.

Describe the solution you'd like

A CI job that deploys to github pages on changes to the docs folder.

Describe alternatives you've considered

Leave docs rendered by github in the repo but that makes it harder to discover.

Additional context

CCF Use sphinx for their docs so would help keep it in style.
@jeffa5 jeffa5 added enhancement New feature or request automation Work on the repo automation documentation Improvements or additions to documentation labels Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
automation Work on the repo automation documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jeffa5