i-VRESSE / bartender

Middleware web service to schedule jobs on various infrastructures
https://i-vresse-bartender.readthedocs.io
Apache License 2.0
1 stars 0 forks source link

Create readthedocs/sphinx site #13

Closed sverhoeven closed 1 year ago

sverhoeven commented 2 years ago

The README is becoming large and mixes user and developer docs.

It would be nice to have a documentation site using Sphinx and hosted on Readthedocs.

Use https://i-vresse-bartender.readthedocs.io/ as https://bartender.readthedocs.io/ is already taken.

README could be split into

Peter9192 commented 1 year ago

Or use GH actions bartender.github.io? Ben recently wrote a nice blog about versioned docs on GH pages.

sverhoeven commented 1 year ago

Add Markdown support with myst see https://github.com/i-VRESSE/bartender/pull/17/files#r1085534781

Peter9192 commented 1 year ago

On myst compatibility with sphinx v6, there are two issues and a merged PR: https://github.com/executablebooks/MyST-Parser/issues/660, https://github.com/executablebooks/MyST-NB/issues/466, https://github.com/executablebooks/MyST-Parser/pull/664, just no new release yet.

Peter9192 commented 1 year ago

To do: