From: Petr Vorel <pvorel@suse.cz>
To: Cyril Hrubis <chrubis@suse.cz>,
Andrea Cervesato <andrea.cervesato@suse.de>,
Li Wang <liwang@redhat.com>
Cc: ltp@lists.linux.it
Subject: [LTP] [RFC] Convert test catalog (docparse) from asciidoc to readthedocs.io (sphinx)
Date: Fri, 27 Dec 2024 08:39:21 +0100 [thread overview]
Message-ID: <20241227073921.GB290415@pevik> (raw)
Hi
I suggest to convert test catalog ("docparse") generated by docparse/testinfo.pl
and asciidoc/asciidoctor to sphinx generator (readthedocs.io).
asciidoc/asciidoctor was a good choice at the time, but now it looks to me
better to use sphinx for everything.
I volunteer to do the work, but I would like to have a general agreement before
I do it.
Pros:
* We already have attempt to show tested syscalls [1]. Printing test catalog would
have more info.
* No need to install dependencies.
* Automatic. If we add also doc for stable releases, it would replace the need
to install dependencies and upload file to LTP release on GitHub [2]. Then only
link to page to test coverage on linux-test-project.readthedocs.io of particular
release (or link to whole doc on particular release) would be added in release
mail announcement (or we might keep adding generated pdf/epub/zipped html also
to LTP releases [2]).
* Unified look and feel.
Work needed:
* Convert docparse/testinfo.pl to doc/conf.py, obviously change from asciidoc
to spinx.
* Adding stable releases (not sure if it can be created automatically for all
tags).
* Adding offline formats [3] so that users can download the docs (that would be
useful anyway).
Kind regards,
Petr
[1] https://linux-test-project.readthedocs.io/en/latest/users/stats.html
[2] https://github.com/linux-test-project/ltp/releases
[3] https://docs.readthedocs.io/en/stable/downloadable-documentation.html
--
Mailing list info: https://lists.linux.it/listinfo/ltp
next reply other threads:[~2024-12-27 7:39 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-27 7:39 Petr Vorel [this message]
2024-12-27 8:05 ` [LTP] [RFC] Convert test catalog (docparse) from asciidoc to readthedocs.io (sphinx) Petr Vorel
2024-12-30 8:55 ` Li Wang
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20241227073921.GB290415@pevik \
--to=pvorel@suse.cz \
--cc=andrea.cervesato@suse.de \
--cc=chrubis@suse.cz \
--cc=liwang@redhat.com \
--cc=ltp@lists.linux.it \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.