[crmsh-4.6] Dev: doc: implement help2adoc (#1374) #1380
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
nicholasyang2022
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## crmsh-4.6 #1380 +/- ##
==========================================
Coverage 52.84% 52.84%
==========================================
Files 79 79
Lines 23949 23949
==========================================
Hits 12655 12655
Misses 11294 11294 ☔ View full report in Codecov by Sentry. |
Fixed in 0d66d03 |
convert help text generated by python's argparse to asciidoc
extracts sections needed to be generated from argparse help from tags in crm.8.adoc and generates Makefile for building those adocs
usage: `podman run --rm -ti -v <crmsh source root dir>:/opt/crmsh local/crmsh-doc-builder:latest`
…oc (ClusterLabs#1374) To generate a complete document, those sections generated from argparse help needed to be included from crm.8.adoc
`make all` now generates crm.8.html.
nicholasyang2022
force-pushed
the
help2adoc
branch
from
f94beaa to
497303f
Compare
|
Great job! Then the next stage will be auto-submit the web contents to crmsh.github.io, in a GH action I guess, right? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes:
help2adocto convert the help text generated by pythonargparsemodule to asciidochelp2adocandcrm.8.adocto generated a complete documentUsage:
The final results is
doc/generated-sources/crm.8.adocanddoc/generated-sources/crm.8.htmlPart of #1374.