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

More fixes to docs markup, recipes, scripting #2799

Merged
merged 10 commits into from
Feb 10, 2025

Conversation

jimklimov
Copy link
Member

  • Follow-up to PRs for Please add Documentation= field in systemd .service files #722 : adjust man-page URL for "NUT home page" in release snapshots (use historic sub-site as NUT_WEBSITE_BASE)
  • Improve ci_build.sh to help iterate with docs and their recipes
  • Fix the general build routine to complete all requested doc types as part of build (previously some were not built until make dist or make check, effectively because make man in docs directory was satisfied that man subdir exists)
  • Revise recipes to pass asciidoc/a2x CLI arguments in the same style (also done in nut-website recipes)

…e script of developer builds

Finally allow to not skip doc builds when developing just them :)

Signed-off-by: Jim Klimov <[email protected]>
…tually building (developer-oriented) "inplace" or with certain "docs" request

Signed-off-by: Jim Klimov <[email protected]>
…x DOC_BUILD_LIST to include "man-man" recipe, not "man" which is a dirname

Signed-off-by: Jim Klimov <[email protected]>
…home page" to consider @NUT_WEBSITE_BASE@ (for historic releases) [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
…ink spelling for curious readers of asciidoc source (not html/man/pdf renditions that needed escaping)

Signed-off-by: Jim Klimov <[email protected]>
…SITE_BASE to asciidoc attributes [networkupstools#722, networkupstools#2733, networkupstools#2743]

If we ever decide to forgo rewritting of man page numbers and website
URLs during creation of *-prepped sources fed into asciidoc (as done
by PRs above) and directly use expadable asciidoc attributes in text,
the Makefiles are ready. One downside is that plaintext original docs
would become barely useful, with all those links externalized...

Signed-off-by: Jim Klimov <[email protected]>
@jimklimov jimklimov added enhancement packaging documentation CI Entries related to continuous integration infrastructure (historically also recipes like Makefiles) portability We want NUT to build and run everywhere possible labels Feb 9, 2025
@jimklimov jimklimov added this to the 2.8.3 milestone Feb 9, 2025
@jimklimov jimklimov changed the title More fixes to docs markup More fixes to docs markup, recipes, scripting Feb 9, 2025
@jimklimov jimklimov merged commit 356079f into networkupstools:master Feb 10, 2025
25 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Entries related to continuous integration infrastructure (historically also recipes like Makefiles) documentation enhancement packaging portability We want NUT to build and run everywhere possible
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant