From: Andrea Cervesato via ltp <ltp@lists.linux.it>
To: "ltp@lists.linux.it" <ltp@lists.linux.it>
Subject: [LTP] New LTP documentation!
Date: Mon, 18 Mar 2024 13:41:38 +0100 [thread overview]
Message-ID: <6868ae95-b004-4fb2-8aac-7ccf96b32f90@suse.com> (raw)
Hello everyone,
as already mentioned in the monthly LTP meeting, Linux Test Project
lacks of a nice and clean documentation that can be easily accessed by
users, developers and maintainers.
The current LTP documentation is also not matching with our expectancy
towards the entire project, which is has been heavily refactored and it
has changed in the past years, providing a higher quality code and new
testing features.
For this reasons, we think it's time to move forward and to start
working on documentation, helping people to use, to develop and to
maintain LTP in an easier way, increasing quality of the overall project
and to call more developers in the community.
I started to work on documentation refactoring, re-organizing the
overall structure. The first prototype can be found here:
https://ltp-acerv.readthedocs.io/en/latest/index.html
The idea is to move documents from the current asciidoc format to RST
format, following the current kernel docs guide lines [1], and to move
API headers descriptions from regular C comments to Doxygen format.
By using the powerful readthedocs service [2], it's possible to deploy a
documentation website with one simple setup, using Sphinx [3] as the
main documentation framework.
For now, website prototype is showing a couple of pages, but the overall
structure is there and ready to be filled.
The purpose of this email is to ask for feedback and ideas from the LTP
community, so we can make documentation even better. Let me know what
you think.
Have a good day,
Andrea Cervesato
[1] https://docs.kernel.org/doc-guide/sphinx.html#writing-documentation
[2] https://about.readthedocs.com/?ref=readthedocs.com
[3] https://www.sphinx-doc.org/en/master
--
Mailing list info: https://lists.linux.it/listinfo/ltp
next reply other threads:[~2024-03-18 12:42 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-18 12:41 Andrea Cervesato via ltp [this message]
2024-03-18 17:01 ` [LTP] New LTP documentation! Petr Vorel
2024-03-19 8:06 ` Andrea Cervesato via ltp
2024-03-19 10:33 ` Cyril Hrubis
2024-03-19 12:28 ` Li Wang
2024-03-19 14:40 ` Cyril Hrubis
2024-03-20 2:52 ` Li Wang
2024-03-20 7:44 ` Andrea Cervesato via ltp
2024-03-20 7:48 ` Li Wang
2024-04-10 10:12 ` Petr Vorel
2024-04-11 9:00 ` Li Wang
2024-04-11 13:38 ` Petr Vorel
2024-04-13 4:03 ` Li Wang
2024-04-12 8:34 ` Andrea Cervesato via ltp
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=6868ae95-b004-4fb2-8aac-7ccf96b32f90@suse.com \
--to=ltp@lists.linux.it \
--cc=andrea.cervesato@suse.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).