5.0.8: not able to generate documentation
kloczek opened this issue · 6 comments
Looks like some files are missing in git repo
+ sphinx-build -b man -d decorator docs .
Running Sphinx v3.5.4
WARNING: html_static_path entry '_static' does not exist
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 0 added, 0 changed, 0 removed
Sphinx error:
master file /home/tkloczko/rpmbuild/BUILD/decorator-5.0.8/docs/index.rst not foundThe documentation of the decorator module is not meant to be generated with sphinx anymore. I should remove the file docs/conf.py.
That is file.
Q: so how should generate documentation as man page? :)
You are the first one asking for this. I suppose I could restore the Sphinx support. I did not know it can also generate man pages.
And not only html and man 😎
From sphinx-build(1) page:
OPTIONS
-b buildername
The most important option: it selects a builder. The most common builders are:
html Build HTML pages. This is the default builder.
dirhtml
Build HTML pages, but with a single directory per document. Makes for prettier URLs (no .html) if served from a webserver.
singlehtml
Build a single HTML with the whole content.
htmlhelp, qthelp, devhelp, epub
Build HTML files with additional information for building a documentation collection in one of these formats.
applehelp
Build an Apple Help Book. Requires hiutil and codesign, which are not Open Source and presently only available on Mac OS X 10.6 and higher.
latex Build LaTeX sources that can be compiled to a PDF document using pdflatex.
man Build manual pages in groff format for UNIX systems.
texinfo
Build Texinfo files that can be processed into Info files using makeinfo.
text Build plain text files.
gettext
Build gettext-style message catalogs (.pot files).
doctest
Run all doctests in the documentation, if the doctest extension is enabled.
linkcheck
Check the integrity of all external links.
xml Build Docutils-native XML files.
pseudoxml
Build compact pretty-printed "pseudo-XML" files displaying the internal structure of the intermediate document trees.
See /usage/builders/index for a list of all builders shipped with Sphinx. Extensions can add their own builders.Some years ago I moved away from reStructuredText and switched to Markdown. However Sphinx supports Markdown too (see https://www.sphinx-doc.org/en/master/usage/markdown.html). Can you install the myst-parser and see if you can get the man page? Otherwise I see that there are tools converting markdown into man pages, like https://github.com/sunaku/md2man.