It is related. That one creates the python optional dependencies so that rtd can pull in the correct verisions of sphinx, etc. in the .readthedocs.yaml file

I have no clue how this works but it would be nice to generate the documentation from the sources directly.
The content of man.pod is actually the src/docs/pod/beakerlib.pod which is built by make.

The content of man.pod is actually the src/docs/pod/beakerlib.pod which is built by make.

Thanks for the tip. Can you expand on this a bit, how is beakerlib.pod generated? Can it output a markdown file format? And what programs are needed to run relevant part of the make script?

it would be nice to generate the documentation from the sources directly

About that, could you enable the integration on https://readthedocs.org/ with PR support?

The content of man.pod is actually the src/docs/pod/beakerlib.pod which is built by make.

Thanks for the tip. Can you expand on this a bit, how is beakerlib.pod generated? Can it output a markdown file format? And what programs are needed to run relevant part of the make script?

Following will create the pod file.

cd src
make docs/pod/beakerlib.pod

AFAIK, perl is needed for it to work.
POD is the inline documentation which may be converted to various format using pod2* tools.

it would be nice to generate the documentation from the sources directly

About that, could you enable the integration on https://readthedocs.org/ with PR support?

I created a project there and enabled the PR builds https://beakerlib.readthedocs.io/en/latest/. Otherwise I have no experience with that. Not sure what all need to be set there. I may give you rights there.

https://beakerlib--157.org.readthedocs.build/en/157/index.html

There we go. I'll try to get the pod2pandoc working tomorrow. Now for the actual documentation page, any preference or reference you want to have implemented?

https://beakerlib--157.org.readthedocs.build/en/157/index.html

There we go. I'll try to get the pod2pandoc working tomorrow. Now for the actual documentation page, any preference or reference you want to have implemented?

What kind of reference do you mean? Personally I have no preferences. As this is completely new thing, I would leave it on you. We can discuss / tweak the result later, if necessary.

What kind of reference do you mean?

I was thinking if you had a documentation page you like and want to emulate.

Well the framework is more-or-less in place. Now it's just to actually make the pages as we want to. I would have preferred to use pandoc to get more control over the format, but pod2pandoc is not available on fedora for me to try it out.

Anyway, review please?

Seems fine to me. @hegerj, could you take a look as well?

Looks good to me, however I too have limited understanding of how it works.

@psss can I ask you for a quick review as someone with the readthedocs knowledge?

@psss when you have the time, I had the idea for beakerlib/libraries#13, since it can touch tmt stuff as well. Would be nice to make them more visible and get more people on board to have reusable tests there.

Yeah, good idea to make them more visible. Added a comment there.