podman-py icon indicating copy to clipboard operation
podman-py copied to clipboard

Documentation?

Open space55 opened this issue 3 years ago • 1 comments

Hi,

I've been looking around a little bit for solid documentation for this project, as I plan to utilize it. I noticed there's no ReadTheDocs site, and mkdocs doesn't build anything except for a 404 page. I was curious if there is documentation hosted here, on GitHub Pages, on RTD, or others, or if there are plans do to so?

Thanks in advance!

space55 avatar May 28 '21 22:05 space55

@space55 It is on roadmap for this project. make docs will populate the build/html directory with documentation.

jwhonce avatar Jun 08 '21 16:06 jwhonce

Could you create a CI job to run that command? Documentation really comes in handy :)

aparcar avatar Feb 18 '23 11:02 aparcar

@baude Is the ReadTheDocs refactor still in progress?

jwhonce avatar Feb 21 '23 16:02 jwhonce

Docs are published now on readthedocs https://podman-py.readthedocs.io/en/latest/

umohnani8 avatar Jan 22 '24 18:01 umohnani8