Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert test catalog generation to readthedocs.io (sphinx) #1213

Open
pevik opened this issue Jan 6, 2025 · 0 comments
Open

Convert test catalog generation to readthedocs.io (sphinx) #1213

pevik opened this issue Jan 6, 2025 · 0 comments

Comments

@pevik
Copy link
Member

pevik commented Jan 6, 2025

Original test catalog generation was written long time ago we started using sphinx on https://linux-test-project.readthedocs.io/.

Convert perl to produce generation via doc/conf.py. It will be page in https://linux-test-project.readthedocs.io/ instead of separate html/pdf.

After this whole asciidoc/asciidoctor detection in configure.ac, m4/ax_prog_perl_modules.m4, m4/ltp-docparse.m4 can be deleted.

NOTE: We want to keep LTP specific format for headers, e.g. [Description] or [Algorithm]. We don't want to convert them to header level 1 (e.g. not # Description) because we don't want to didn't want to have any heading levels exposed in the doc comments. Also bullet lists or enumerated lists looks the same in reStructuredText, thus doc in the tests does not need to be touched.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant