Bug #4531
open
NAME section is missing in HTML manpages
0%
Description
docs/conf.py controls the titles of manpages. They are rendered correctly by the man builder (as a .SH NAME section), but the same section is missing in the HTML output.
This issue is to fix the build scripts so that a NAME section with the title appears in HTML output, same as what's shown in man command.
Updated by Davide Pesavento over 6 years ago
I don't see anything obviously wrong with our build scripts or in docs/conf.py, and as far as I can see there are no specific options in sphinx to enable/disable generation of the NAME section. So I believe this is a bug or missing feature in sphinx.
Updated by Junxiao Shi over 6 years ago
I couldn't even find the documentation about sphinx's manpage generation. Have you found it?
Updated by Davide Pesavento over 6 years ago
Junxiao Shi wrote:
I couldn't even find the documentation about sphinx's manpage generation. Have you found it?
http://www.sphinx-doc.org/en/stable/config.html#options-for-manual-page-output
Updated by Davide Pesavento over 5 years ago
I suggest to stop using sphinx to generate HTML man pages. I don't think that's a supported use case. There are easier (and more standard) ways to do that. For example: cat /usr/share/man/man${section}/${page}.${section} | groff -mandoc -Thtml > ${page}.html
Updated by Davide Pesavento almost 2 years ago
- Priority changed from Normal to Low
Another option is using mandoc to produce the HTML pages.