ContribfestGood First Issuedocumentationkind/feature
仓库指标
- Star
- (31,686 star)
- PR 合并指标
- (30 天内没有已合并 PR)
描述
Feature request description
#19695 gave me a taste for how tricky and inconsistent our docs are. We do not have useful doc links. We should.
Any time a doc page says 'podman-foo(1)', it should be a clickable link in the HTML pages. (Man pages, there's nothing we can do).
Suggest potential solution
Sphinx seems to be able to filter: https://github.com/containers/podman/blob/f38668e3220650630d3fab9df490bc1c2849b16e/docs/source/conf.py#L83-L94
It should be possible to do:
re.sub('podman-foo-paren-N-closeparen', code{if podman-foo.N.md exists, convert to '[podman-foo(N)](podman-foo.N.md)' , else, leave it alone)
Have you considered any alternatives?
Could also be done in hack/markdown-preprocess, but that would only handle .md.in files
Additional context
No response