Sphinx-build: using man builder name and checking whether created man pages are correctly displayed

Question

I am new to sphinx and I have currently used it to generate man pages using the man builder name through sphinx-build.

Man pages seems they are successfully generated since the final output after executing sphinx-build is:

build succeeded.

The manual pages are in build\man.

Within build\man folder I can see there are a lot of files called as filename.1

Anyway, I would like to check that those man pages have been correctly created and also I would like to check how they are displayed from Windows. So is there any way I can check this from Windows?

I have found mandoc and groff for windows. – Willy Jan 19 '22 at 17:25 — Willy, Jan 19 '22 at 17:25

score 0 · Accepted Answer · answered Jan 20 '22 at 09:54

I have finally found mandoc and groff for Windows. Also groff is discussed here as accepted answer.

Usages from Windows command prompt

groff:

groff -Tascii -mm your_file | more for compatibility mode use:

groff -C -Tascii -mm your_file | more

groff for Windows can be downloaded from here

mandoc:

mandoc.exe manpage.1 | more

Sphinx-build: using man builder name and checking whether created man pages are correctly displayed

1 Answers1