[CI:DOCS] Improve titles of command HTML pages #10167
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
When building Sphinx HTML docs, preprocess markdown files and convert pandoc-style title lines into recommonmark eval_rst blocks This gives command HTML pages the same title as the equivalent manpage Fixes: containers/podman.io#385 Signed-off-by: Rob Cowsill <[email protected]>
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mheon, rcowsill The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci-robot
added
the
approved
|
Thanks @rcowsill. This looks great. |
|
/lgtm |
|
Thanks @rcowsill Awesome job. |
|
@rcowsill too late to review, but did want to TYVM for this fix. It looks awesome! |
github-actions
bot
added
the
locked - please file new issue/PR
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
As detailed in containers/podman.io#385, the titles of the command HTML pages were all set to "NAME - Podman documentation". This made search results confusing.
This PR gives command HTML pages the same title as the equivalent manpage. The existing pandoc-style title lines are converted at build time into the format supported by recommonmark.
This also removes the
% pandoc-<command name>(1)line from the top of each command's HTML page.