[CMAKE] Transform man pages for web rendering
ClosedPublic
Actions

Authored by Fabien on Aug 25 2020, 21:29.

Details

Reviewers

deadalnix

Group Reviewers

Restricted Project

Commits

rABC894d51ac250d: [CMAKE] Transform man pages for web rendering

Summary

This diff adds a new install-manpages-html target which converts and
installs man pages as jekyll compliant files to the
<install_dir>/share/man/html directory.
This will be useful for integrating the manpages to the website.

Test Plan

Should install and convert the man pages:

ninja install-manpages-html

Diff Detail

Repository

rABC Bitcoin ABC

Branch

cmake_man2html

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 12468
Build 25090: Build Diff	build-diff · build-without-wallet · build-clang-tidy · build-clang-10
Build 25089: arc lint + arc unit

Event Timeline

Fabien created this revision.Aug 25 2020, 21:29

Herald added a reviewer: Restricted Project. · View Herald TranscriptAug 25 2020, 21:29

Fabien requested review of this revision.Aug 25 2020, 21:29

Harbormaster completed remote builds in B12463: Diff 23033.Aug 25 2020, 21:44

deadalnix requested changes to this revision.Aug 25 2020, 23:04

deadalnix added a subscriber: deadalnix.

deadalnix added inline comments.

cmake/templates/man2www.sh.in
1 ↗	(On Diff #23033)	www is not a file format. Can you rename this?

This revision now requires changes to proceed.Aug 25 2020, 23:04

Fabien edited the summary of this revision. (Show Details)Aug 26 2020, 06:56

Fabien edited the test plan for this revision. (Show Details)

Fabien added inline comments.

cmake/templates/man2www.sh.in
1 ↗	(On Diff #23033)	OK I'll switch to HTML. Note that the file currently contains no html but is plain text, and the website displays it as a raw text block as well. But I have a plan for making it full hml and improve the rendering, so this will become accurate in a near future.