Open kloczek opened 2 years ago
The man
builder isn't really supported.
Quite recently, the text
builder has gotten minimal support: #615
Maybe something similar (or even the exact same thing?) can be done for the man
builder?
It would be really nice to have roff outpu support asd man pages are still basic format of the sodumentation delivered across most of the projects o Unix platforms 😄
Just tested nbconvert 6.5.0 and I'm no longer able to reproduce that issue. Closing.
+ /usr/bin/sphinx-build -n -T -b man docs/source build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
loading intersphinx inventory from https://docs.python.org/3.6/objects.inv...
loading intersphinx inventory from http://jinja.pocoo.org/docs/objects.inv...
loading intersphinx inventory from https://nbformat.readthedocs.io/en/latest/objects.inv...
intersphinx inventory has moved: http://jinja.pocoo.org/docs/objects.inv -> https://jinja.palletsprojects.com/en/3.1.x/objects.inv
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 22 added, 0 changed, 0 removed
reading sources... [100%] usage
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/docs/source/config_options.rst:2231: ERROR: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/docs/source/config_options.rst:2234: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/docs/source/config_options.rst:2794: ERROR: Unexpected indentation.
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/docs/source/config_options.rst:2797: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/docs/source/index.rst:33: WARNING: toctree contains reference to nonexisting document 'nbconvert_library'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-nbconvert.3 { install usage dejavu latex_citations removing_cells execute_api config_options customizing external_exporters highlighting architecture api/index api/nbconvertapp api/exporters api/preprocessors api/filters api/writers api/postprocessors development_release changelog need_help } /home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/docs/source/execute_api.rst:11: WARNING: unknown document: nbconvert_library
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/nbconvertapp.py:docstring of nbconvert.nbconvertapp.NbConvertApp.write_single_notebook:: WARNING: py:class reference target not found: file
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/base.py:docstring of nbconvert.exporters.base.export:9: WARNING: py:class reference target not found: nbformat.NotebookNode
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/base.py:docstring of nbconvert.exporters.base.export:: WARNING: py:class reference target not found: config
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/base.py:docstring of nbconvert.exporters.base.export:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/base.py:docstring of nbconvert.exporters.base.export:: WARNING: py:class reference target not found: keyword arg
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/base.py:docstring of nbconvert.exporters.base.export:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/base.py:docstring of nbconvert.exporters.base.export:: WARNING: py:class reference target not found: keyword arg
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/exporter.py:docstring of nbconvert.exporters.exporter.Exporter.from_notebook_node:4: WARNING: py:class reference target not found: nbformat.NotebookNode
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/exporter.py:docstring of nbconvert.exporters.exporter.Exporter.from_file:: WARNING: py:class reference target not found: file-like object
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/templateexporter.py:docstring of nbconvert.exporters.templateexporter.TemplateExporter.__init__:: WARNING: py:class reference target not found: config
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/templateexporter.py:docstring of nbconvert.exporters.templateexporter.TemplateExporter.__init__:: WARNING: py:class reference target not found: of Jinja Loaders
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/templateexporter.py:docstring of nbconvert.exporters.templateexporter.TemplateExporter.__init__:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/templateexporter.py:docstring of nbconvert.exporters.templateexporter.TemplateExporter.__init__:: WARNING: py:class reference target not found: kw arg
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/templateexporter.py:docstring of nbconvert.exporters.templateexporter.TemplateExporter.from_notebook_node:4: WARNING: py:class reference target not found: nbformat.NotebookNode
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/exporters/exporter.py:docstring of nbconvert.exporters.exporter.Exporter.from_file:: WARNING: py:class reference target not found: file-like object
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/base.py:docstring of nbconvert.preprocessors.base.Preprocessor.__init__:: WARNING: py:class reference target not found: Config
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/base.py:docstring of nbconvert.preprocessors.base.Preprocessor.preprocess:: WARNING: py:class reference target not found: NotebookNode
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/base.py:docstring of nbconvert.preprocessors.base.Preprocessor.preprocess:: WARNING: py:class reference target not found: dictionary
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/base.py:docstring of nbconvert.preprocessors.base.Preprocessor.preprocess_cell:: WARNING: py:class reference target not found: NotebookNode cell
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/base.py:docstring of nbconvert.preprocessors.base.Preprocessor.preprocess_cell:: WARNING: py:class reference target not found: dictionary
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/execute.py:docstring of nbconvert.preprocessors.execute.ExecutePreprocessor.preprocess:: WARNING: py:class reference target not found: nbformat.notebooknode.NotebookNode
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/execute.py:docstring of nbconvert.preprocessors.execute.ExecutePreprocessor.preprocess:: WARNING: py:class reference target not found: NotebookNode
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/execute.py:docstring of nbconvert.preprocessors.execute.ExecutePreprocessor.preprocess:: WARNING: py:class reference target not found: dictionary
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/execute.py:docstring of nbconvert.preprocessors.execute.ExecutePreprocessor.preprocess:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/execute.py:docstring of nbconvert.preprocessors.execute.ExecutePreprocessor.preprocess:: WARNING: py:class reference target not found: KernelManager
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/execute.py:docstring of nbconvert.preprocessors.execute.ExecutePreprocessor.preprocess:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/execute.py:docstring of nbconvert.preprocessors.execute.ExecutePreprocessor.preprocess_cell:: WARNING: py:class reference target not found: NotebookNode cell
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/execute.py:docstring of nbconvert.preprocessors.execute.ExecutePreprocessor.preprocess_cell:: WARNING: py:class reference target not found: dictionary
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/coalescestreams.py:docstring of nbconvert.preprocessors.coalescestreams.coalesce_streams:: WARNING: py:class reference target not found: NotebookNode cell
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/preprocessors/coalescestreams.py:docstring of nbconvert.preprocessors.coalescestreams.coalesce_streams:: WARNING: py:class reference target not found: dictionary
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/ansi.py:docstring of nbconvert.filters.ansi.ansi2html:: WARNING: py:class reference target not found: unicode
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/ansi.py:docstring of nbconvert.filters.ansi.ansi2latex:: WARNING: py:class reference target not found: unicode
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/strings.py:docstring of nbconvert.filters.strings.get_lines:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/strings.py:docstring of nbconvert.filters.strings.get_lines:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/pandoc.py:docstring of nbconvert.filters.pandoc.convert_pandoc:: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/pandoc.py:docstring of nbconvert.filters.pandoc.convert_pandoc:: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/pandoc.py:docstring of nbconvert.filters.pandoc.convert_pandoc:: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/pandoc.py:docstring of nbconvert.filters.pandoc.convert_pandoc:: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/utils/text.py:docstring of nbconvert.utils.text.indent:: WARNING: py:class reference target not found: basestring
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/utils/text.py:docstring of nbconvert.utils.text.indent:: WARNING: py:class reference target not found: default: 4
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/utils/text.py:docstring of nbconvert.utils.text.indent:: WARNING: py:class reference target not found: default: 0
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/utils/text.py:docstring of nbconvert.utils.text.indent:: WARNING: py:class reference target not found: default: False
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/utils/text.py:docstring of nbconvert.utils.text.indent:: WARNING: py:class reference target not found: string indented by ntabs and nspaces.
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/markdown.py:docstring of nbconvert.filters.markdown.markdown2latex:: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/markdown.py:docstring of nbconvert.filters.markdown.markdown2latex:: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/markdown.py:docstring of nbconvert.filters.markdown.markdown2latex:: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/markdown.py:docstring of nbconvert.filters.markdown.markdown2rst:: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/markdown.py:docstring of nbconvert.filters.markdown.markdown2rst:: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/filters/strings.py:docstring of nbconvert.filters.strings.wrap_text:: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/nbconvert-6.5.0/nbconvert/writers/base.py:docstring of nbconvert.writers.base.WriterBase.write:: WARNING: py:class reference target not found: string
done
build succeeded, 56 warnings.
gentle ping .. 🤔
Looks like nbsphinx
0.8.10 has problem with rendering its own documentation as well
List of modules installed in build env:
Looks like
nbsphinx
0.8.10 has problem with rendering its own documentation as well
Sure. As I said, the man
builder isn't really supported.
I'm not planning to implement this, but I'm open for pull requests!
I'm buuklding all my rpm packages with pyton modules with sphinx documentation renedered as man pages. Rendering
nbconvert
man page I found that sphisnx fails with call traceDisabling sphinx extensins listed in copy.py:
I found that afterremove from above
nbsphinx
I found that I was able to render man page with exit 0.So looks like that potentially something mey be wrong with
nbsphinx
.May I ask for some help?