Re: [LTP] [PATCH 00/10] New LTP documentation

[Petr Vorel <pvorel@suse.cz>]

Hi Andrea,

> The new LTP documentation is meant to use Sphinx as the main
> documentation framework, with ReconStructedText as the main language.
> All the conversion has been done step-by-step, each chapter at time,
> updating english syntax and fixing typos. There are minor improvements,
> but overall the structure is the same.

> C / Networking / KVM API are not documented yet, because they will be
> probably integrated in the LTP library. C API documentation is already
> on going, but the others not.

> For a demo, please take a look at:

> https://ltp-acerv.readthedocs.io/en/latest/index.html

Out of curiosity, we need to register LTP on readthedocs.io.
Then we need GitHub Action hook (including some secret for auth) for publishing.
Correct?

https://docs.readthedocs.io/en/stable/guides/setup/git-repo-manual.html

I guess you now deploy to your fork manually, otherwise you would add GitHub
Action config in the patchset.

Also, what I like (for the future) offline formats (PDF, ePub, HTML) are
supported:

https://docs.readthedocs.io/en/stable/downloadable-documentation.html

Also, I would prefer when this merged it would actually replace the old github
docs (otherwise we maintainers endup maintaining both - getting fixes for both).
E.g. in the final version first deleting the old docs + github update hook.

Kind regards,
Petr

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp