search

readthedocs / sphinx_rtd_theme

Sphinx theme from Read the Docs
https://sphinx-rtd-theme.readthedocs.io/
MIT License
4.79k stars 1.74k forks source link

1.1.0: sphinx-build fails with call trace on building man page for `libcst` #1377

Closed kloczek closed 1 year ago

kloczek commented 1 year ago

Problem

sphinx-build fails with call trace on building man page for libcstGive details on your issue.

```console + /usr/bin/sphinx-build -n -T -b man docs/source build/sphinx/man Running Sphinx v5.3.0 making output directory... done [autosummary] generating autosummary for: best_practices.rst, codemods.rst, codemods_tutorial.rst, experimental.rst, helpers.rst, index.rst, matchers.rst, matchers_tutorial.ipynb, metadata.rst, metadata_tutorial.ipynb, motivation.rst, nodes.rst, parser.rst, scope_tutorial.ipynb, tutorial.ipynb, visitors.rst, why_libcst.rst loading intersphinx inventory from https://docs.python.org/3/objects.inv... building [mo]: targets for 0 po files that are out of date building [man]: all manpages updating environment: [new config] 17 added, 0 changed, 0 removed reading sources... [100%] why_libcst /usr/lib/python3.8/site-packages/libcst/metadata/full_repo_manager.py:docstring of libcst.metadata.full_repo_manager.FullRepoManager.__init__:1: WARNING: Field list ends without a blank line; unexpected unindent. /usr/lib/python3.8/site-packages/libcst/metadata/full_repo_manager.py:docstring of libcst.metadata.full_repo_manager.FullRepoManager.__init__:10: ERROR: Unexpected indentation. looking for now-outdated files... none found pickling environment... done checking consistency... done writing... python-libcst.3 { why_libcst motivation tutorial metadata_tutorial scope_tutorial matchers_tutorial codemods_tutorial best_practices parser nodes visitors metadata matchers codemods helpers experimental } /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/metadata_tutorial.ipynb:15: WARNING: py:class reference target not found: libcst.BatchableMetadataProvider /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/metadata_tutorial.ipynb:58: WARNING: py:class reference target not found: libcst.MetadataWrapper /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/metadata_tutorial.ipynb:61: WARNING: py:class reference target not found: libcst.MetadataWrapper /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/best_practices.rst:11: WARNING: py:func reference target not found: libcst.ensure_type /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/best_practices.rst:15: WARNING: py:func reference target not found: libcst.ensure_type /usr/lib/python3.8/site-packages/libcst/_parser/types/config.py:docstring of libcst.PartialParserConfig.python_version:1: WARNING: py:class reference target not found: libcst._parser.types.config.AutoConfig /usr/lib/python3.8/site-packages/libcst/_parser/types/config.py:docstring of libcst.PartialParserConfig.parsed_python_version:1: WARNING: py:class reference target not found: libcst._parser.parso.utils.PythonVersionInfo /usr/lib/python3.8/site-packages/libcst/_parser/types/config.py:docstring of libcst.PartialParserConfig.encoding:1: WARNING: py:class reference target not found: libcst._parser.types.config.AutoConfig /usr/lib/python3.8/site-packages/libcst/_parser/types/config.py:docstring of libcst.PartialParserConfig.future_imports:1: WARNING: py:class reference target not found: libcst._parser.types.config.AutoConfig /usr/lib/python3.8/site-packages/libcst/_parser/types/config.py:docstring of libcst.PartialParserConfig.default_indent:1: WARNING: py:class reference target not found: libcst._parser.types.config.AutoConfig /usr/lib/python3.8/site-packages/libcst/_parser/types/config.py:docstring of libcst.PartialParserConfig.default_newline:1: WARNING: py:class reference target not found: libcst._parser.types.config.AutoConfig /usr/lib/python3.8/site-packages/libcst/_nodes/base.py:docstring of libcst._nodes.base.CSTNode.visit:1: WARNING: py:class reference target not found: libcst._nodes.base._CSTNodeSelfT /usr/lib/python3.8/site-packages/libcst/_nodes/base.py:docstring of libcst._nodes.base.CSTNode.visit:1: WARNING: py:class reference target not found: libcst._nodes.base._CSTNodeSelfT /usr/lib/python3.8/site-packages/libcst/_nodes/base.py:docstring of libcst._nodes.base.CSTNode.with_changes:1: WARNING: py:class reference target not found: libcst._nodes.base._CSTNodeSelfT /usr/lib/python3.8/site-packages/libcst/_nodes/base.py:docstring of libcst._nodes.base.CSTNode.deep_clone:1: WARNING: py:class reference target not found: libcst._nodes.base._CSTNodeSelfT /usr/lib/python3.8/site-packages/libcst/_nodes/base.py:docstring of libcst._nodes.base.CSTNode.deep_replace:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/_nodes/base.py:docstring of libcst._nodes.base.CSTNode.deep_replace:1: WARNING: py:class reference target not found: libcst._nodes.base._CSTNodeSelfT /usr/lib/python3.8/site-packages/libcst/_nodes/base.py:docstring of libcst._nodes.base.CSTNode.deep_replace:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/_nodes/base.py:docstring of libcst._nodes.base.CSTNode.deep_remove:1: WARNING: py:class reference target not found: libcst._nodes.base._CSTNodeSelfT /usr/lib/python3.8/site-packages/libcst/_nodes/base.py:docstring of libcst._nodes.base.CSTNode.with_deep_changes:1: WARNING: py:class reference target not found: libcst._nodes.base._CSTNodeSelfT /usr/lib/python3.8/site-packages/libcst/_nodes/module.py:docstring of libcst._nodes.module.Module.visit:1: WARNING: py:class reference target not found: libcst._nodes.module._ModuleSelfT /usr/lib/python3.8/site-packages/libcst/_nodes/expression.py:docstring of libcst.UnaryOperation.operator:1: WARNING: py:class reference target not found: libcst._nodes.op.BaseUnaryOp /usr/lib/python3.8/site-packages/libcst/_nodes/expression.py:docstring of libcst.BinaryOperation.operator:1: WARNING: py:class reference target not found: libcst._nodes.op.BaseBinaryOp /usr/lib/python3.8/site-packages/libcst/_nodes/expression.py:docstring of libcst.BooleanOperation.operator:1: WARNING: py:class reference target not found: libcst._nodes.op.BaseBooleanOp /usr/lib/python3.8/site-packages/libcst/_nodes/expression.py:docstring of libcst.ComparisonTarget.operator:1: WARNING: py:class reference target not found: libcst._nodes.op.BaseCompOp /usr/lib/python3.8/site-packages/libcst/_nodes/statement.py:docstring of libcst.AugAssign.operator:1: WARNING: py:class reference target not found: libcst._nodes.op.BaseAugOp /usr/lib/python3.8/site-packages/libcst/_nodes/statement.py:docstring of libcst.BaseSuite.body:1: WARNING: py:class reference target not found: libcst._nodes.statement.BaseStatement /usr/lib/python3.8/site-packages/libcst/_nodes/statement.py:docstring of libcst.IndentedBlock.body:1: WARNING: py:class reference target not found: libcst._nodes.statement.BaseStatement /usr/lib/python3.8/site-packages/libcst/_visitors.py:docstring of libcst.CSTVisitor.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/_visitors.py:docstring of libcst._visitors.CSTTransformer.on_leave:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/_visitors.py:docstring of libcst._visitors.CSTTransformer.on_leave:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/_visitors.py:docstring of libcst._visitors.CSTTransformer.on_leave:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/_visitors.py:docstring of libcst._visitors.CSTTransformer.on_leave:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/_visitors.py:docstring of libcst.CSTTransformer.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/_flatten_sentinel.py:docstring of libcst._flatten_sentinel.FlattenSentinel:1: WARNING: py:class reference target not found: libcst.BaseStatement /usr/lib/python3.8/site-packages/libcst/_flatten_sentinel.py:docstring of libcst._flatten_sentinel.FlattenSentinel:9: WARNING: py:attr reference target not found: cst.RemovalSentinel.REMOVE /usr/lib/python3.8/site-packages/libcst/_flatten_sentinel.py:docstring of libcst.FlattenSentinel.nodes:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT_co /usr/lib/python3.8/site-packages/libcst/_batched_visitor.py:docstring of libcst._batched_visitor.BatchableCSTVisitor:1: WARNING: py:func reference target not found: libcst.MetadataWrapper.visit_batched /usr/lib/python3.8/site-packages/libcst/_batched_visitor.py:docstring of libcst._batched_visitor.BatchableCSTVisitor:1: WARNING: py:class reference target not found: libcst.MetadataWrapper /usr/lib/python3.8/site-packages/libcst/_batched_visitor.py:docstring of libcst.BatchableCSTVisitor.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/_batched_visitor.py:docstring of libcst._batched_visitor.visit_batched:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/_batched_visitor.py:docstring of libcst._batched_visitor.visit_batched:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/_batched_visitor.py:docstring of libcst._batched_visitor.visit_batched:4: WARNING: py:func reference target not found: libcst.MetadataWrapper.visit_batched /usr/lib/python3.8/site-packages/libcst/_batched_visitor.py:docstring of libcst._batched_visitor.visit_batched:4: WARNING: py:class reference target not found: libcst.MetadataWrapper /usr/lib/python3.8/site-packages/libcst/metadata/wrapper.py:docstring of libcst.metadata.wrapper.MetadataWrapper.__init__:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/metadata/wrapper.py:docstring of libcst.metadata.wrapper.MetadataWrapper.resolve:1: WARNING: py:class reference target not found: _T /usr/lib/python3.8/site-packages/libcst/metadata/wrapper.py:docstring of libcst.metadata.wrapper.MetadataWrapper.resolve:1: WARNING: py:class reference target not found: libcst.metadata.wrapper._T /usr/lib/python3.8/site-packages/libcst/metadata/wrapper.py:docstring of libcst.metadata.wrapper.MetadataWrapper.resolve_many:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/metadata/wrapper.py:docstring of libcst.metadata.wrapper.MetadataWrapper.resolve_many:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/metadata/wrapper.py:docstring of libcst.metadata.wrapper.MetadataWrapper.visit:1: WARNING: py:class reference target not found: CSTVisitorT /usr/lib/python3.8/site-packages/libcst/_metadata_dependent.py:docstring of libcst.MetadataDependent.METADATA_DEPENDENCIES:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/_metadata_dependent.py:docstring of libcst.MetadataDependent.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/_metadata_dependent.py:docstring of libcst._metadata_dependent.MetadataDependent.get_inherited_dependencies:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/_metadata_dependent.py:docstring of libcst._metadata_dependent.MetadataDependent.get_metadata:1: WARNING: py:class reference target not found: libcst._metadata_dependent._T /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/metadata.rst:53: WARNING: py:class reference target not found: libcst.metadata.MetadataDependent /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/metadata.rst:59: WARNING: py:class reference target not found: libcst.metadata.BaseMetadataProvider /usr/lib/python3.8/site-packages/libcst/metadata/base_provider.py:docstring of libcst.metadata.base_provider.BaseMetadataProvider.set_metadata:1: WARNING: py:class reference target not found: libcst.metadata.base_provider._ProvidedMetadataT /usr/lib/python3.8/site-packages/libcst/metadata/base_provider.py:docstring of libcst.metadata.base_provider.BaseMetadataProvider.get_metadata:1: WARNING: py:class reference target not found: libcst._metadata_dependent._T /usr/lib/python3.8/site-packages/libcst/metadata/span_provider.py:docstring of libcst.metadata.span_provider.ByteSpanPositionProvider:1: WARNING: py:class reference target not found: CSTNode /usr/lib/python3.8/site-packages/libcst/metadata/scope_provider.py:docstring of libcst.metadata.scope_provider.BaseAssignment:1: WARNING: py:class reference target not found: BuitinAssignment /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/metadata.rst:231: WARNING: py:class reference target not found: libcst.metadata.FullRepoManger /usr/lib/python3.8/site-packages/libcst/metadata/full_repo_manager.py:docstring of libcst.metadata.full_repo_manager.FullRepoManager.__init__:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/metadata/full_repo_manager.py:docstring of libcst.metadata.FullRepoManager.cache:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/metadata/full_repo_manager.py:docstring of libcst.metadata.full_repo_manager.FullRepoManager.get_cache_for_path:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.findall:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._BaseMetadataMatcher /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.extractall:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._BaseMetadataMatcher /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.replace:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._BaseMetadataMatcher /usr/lib/python3.8/site-packages/libcst/matchers/_decorators.py:docstring of libcst.matchers._decorators.visit:1: WARNING: py:class reference target not found: libcst.matchers._decorators._CSTVisitFuncT /usr/lib/python3.8/site-packages/libcst/matchers/_decorators.py:docstring of libcst.matchers._decorators.visit:1: WARNING: py:class reference target not found: libcst.matchers._decorators._CSTVisitFuncT /usr/lib/python3.8/site-packages/libcst/matchers/_decorators.py:docstring of libcst.matchers._decorators.leave:1: WARNING: py:class reference target not found: libcst.matchers._decorators._CSTVisitFuncT /usr/lib/python3.8/site-packages/libcst/matchers/_decorators.py:docstring of libcst.matchers._decorators.leave:1: WARNING: py:class reference target not found: libcst.matchers._decorators._CSTVisitFuncT /usr/lib/python3.8/site-packages/libcst/matchers/_decorators.py:docstring of libcst.matchers._decorators.call_if_inside:1: WARNING: py:class reference target not found: libcst.matchers._decorators._CSTVisitFuncT /usr/lib/python3.8/site-packages/libcst/matchers/_decorators.py:docstring of libcst.matchers._decorators.call_if_inside:1: WARNING: py:class reference target not found: libcst.matchers._decorators._CSTVisitFuncT /usr/lib/python3.8/site-packages/libcst/matchers/_decorators.py:docstring of libcst.matchers._decorators.call_if_not_inside:1: WARNING: py:class reference target not found: libcst.matchers._decorators._CSTVisitFuncT /usr/lib/python3.8/site-packages/libcst/matchers/_decorators.py:docstring of libcst.matchers._decorators.call_if_not_inside:1: WARNING: py:class reference target not found: libcst.matchers._decorators._CSTVisitFuncT /usr/lib/python3.8/site-packages/libcst/matchers/_visitors.py:docstring of libcst.matchers.MatcherDecoratableVisitor.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/matchers/_visitors.py:docstring of libcst.matchers._visitors.MatcherDecoratableTransformer.on_leave:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/matchers/_visitors.py:docstring of libcst.matchers._visitors.MatcherDecoratableTransformer.on_leave:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/matchers/_visitors.py:docstring of libcst.matchers._visitors.MatcherDecoratableTransformer.on_leave:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/matchers/_visitors.py:docstring of libcst.matchers._visitors.MatcherDecoratableTransformer.on_visit:1: WARNING: py:attr reference target not found: RemovalSentinel.REMOVE /usr/lib/python3.8/site-packages/libcst/matchers/_visitors.py:docstring of libcst.matchers._visitors.MatcherDecoratableTransformer.on_visit:1: WARNING: py:func reference target not found: RemoveFromParent /usr/lib/python3.8/site-packages/libcst/matchers/_visitors.py:docstring of libcst.matchers._visitors.MatcherDecoratableTransformer.on_visit:1: WARNING: py:attr reference target not found: RemovalSentinel.REMOVE /usr/lib/python3.8/site-packages/libcst/matchers/_visitors.py:docstring of libcst.matchers.MatcherDecoratableTransformer.metadata:1: WARNING: py:class reference target not found: ProviderT /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/matchers.rst:111: WARNING: py:class reference target not found: libcst.matchers.Expr /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/matchers.rst:111: WARNING: py:class reference target not found: libcst.matchers.Expr /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/matchers.rst:111: WARNING: py:class reference target not found: libcst.matchers.BaseExpression /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/matchers.rst:126: WARNING: py:class reference target not found: libcst.matchers.BaseExpression /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers.OneOf.options:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._MatcherT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers.AllOf.options:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._MatcherT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.DoesNotMatch:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._OtherNodeT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.DoesNotMatch:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._OtherNodeT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.SaveMatchedNode:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._OtherNodeT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.SaveMatchedNode:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._OtherNodeT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.DoNotCare:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base.DoNotCareSentinel /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.DoNotCare:1: WARNING: py:class reference target not found: libcst.matchers.Call /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers.AtLeastN.matcher:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._MatcherT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers.AtLeastN.matcher:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base.DoNotCareSentinel /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.ZeroOrMore:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._MatcherT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.ZeroOrMore:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base.DoNotCareSentinel /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.ZeroOrMore:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._MatcherT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.ZeroOrMore:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base.DoNotCareSentinel /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers.AtMostN.matcher:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._MatcherT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers.AtMostN.matcher:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base.DoNotCareSentinel /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.ZeroOrOne:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._MatcherT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.ZeroOrOne:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base.DoNotCareSentinel /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.ZeroOrOne:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base._MatcherT /usr/lib/python3.8/site-packages/libcst/matchers/_matcher_base.py:docstring of libcst.matchers._matcher_base.ZeroOrOne:1: WARNING: py:class reference target not found: libcst.matchers._matcher_base.DoNotCareSentinel /usr/lib/python3.8/site-packages/libcst/codemod/_codemod.py:docstring of libcst.codemod.Codemod.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/_visitor.py:docstring of libcst.codemod.ContextAwareTransformer.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/_visitor.py:docstring of libcst.codemod.ContextAwareVisitor.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/_command.py:docstring of libcst.codemod.VisitorBasedCodemodCommand.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_gather_imports.py:docstring of libcst.codemod.visitors.GatherImportsVisitor.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_gather_exports.py:docstring of libcst.codemod.visitors.GatherExportsVisitor.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_add_imports.py:docstring of libcst.codemod.visitors.AddImportsVisitor.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_apply_type_annotations.py:docstring of libcst.codemod.visitors.ApplyTypeAnnotationsVisitor.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_gather_unused_imports.py:docstring of libcst.codemod.visitors.GatherUnusedImportsVisitor.unused_imports:1: WARNING: py:class reference target not found: cst.ImportAlias /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_gather_unused_imports.py:docstring of libcst.codemod.visitors.GatherUnusedImportsVisitor.unused_imports:1: WARNING: py:class reference target not found: cst.Import /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_gather_unused_imports.py:docstring of libcst.codemod.visitors.GatherUnusedImportsVisitor.unused_imports:1: WARNING: py:class reference target not found: cst.ImportFrom /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_gather_comments.py:docstring of libcst.codemod.visitors.GatherCommentsVisitor.METADATA_DEPENDENCIES:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_gather_comments.py:docstring of libcst.codemod.visitors.GatherCommentsVisitor.comments:1: WARNING: py:class reference target not found: cst.Comment /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_gather_comments.py:docstring of libcst.codemod.visitors.GatherCommentsVisitor.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_gather_string_annotation_names.py:docstring of libcst.codemod.visitors.GatherNamesFromStringAnnotationsVisitor.METADATA_DEPENDENCIES:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/codemod/visitors/_gather_string_annotation_names.py:docstring of libcst.codemod.visitors.GatherNamesFromStringAnnotationsVisitor.metadata:1: WARNING: py:class reference target not found: ProviderT /usr/lib/python3.8/site-packages/libcst/helpers/_template.py:docstring of libcst.helpers._template.parse_template_module:1: WARNING: py:class reference target not found: libcst._nodes.statement.BaseStatement /usr/lib/python3.8/site-packages/libcst/helpers/_template.py:docstring of libcst.helpers._template.parse_template_module:4: WARNING: py:class reference target not found: libcst.FromImport /usr/lib/python3.8/site-packages/libcst/helpers/_template.py:docstring of libcst.helpers._template.parse_template_expression:1: WARNING: py:class reference target not found: libcst._nodes.statement.BaseStatement /usr/lib/python3.8/site-packages/libcst/helpers/_template.py:docstring of libcst.helpers._template.parse_template_statement:1: WARNING: py:class reference target not found: libcst._nodes.statement.BaseStatement /usr/lib/python3.8/site-packages/libcst/helpers/common.py:docstring of libcst.helpers.common.ensure_type:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/helpers/common.py:docstring of libcst.helpers.common.ensure_type:1: WARNING: py:class reference target not found: libcst._types.CSTNodeT /usr/lib/python3.8/site-packages/libcst/metadata/reentrant_codegen.py:docstring of libcst.metadata.reentrant_codegen.CodegenPartial:1: WARNING: py:meth reference target not found: get_modified_code_range /usr/lib/python3.8/site-packages/libcst/metadata/reentrant_codegen.py:docstring of libcst.metadata.reentrant_codegen.CodegenPartial:1: WARNING: py:meth reference target not found: get_modified_code /usr/lib/python3.8/site-packages/libcst/metadata/reentrant_codegen.py:docstring of libcst.metadata.reentrant_codegen.CodegenPartial.get_modified_statement_code:1: WARNING: py:class reference target not found: libcst._nodes.statement.BaseStatement /usr/lib/python3.8/site-packages/libcst/metadata/reentrant_codegen.py:docstring of libcst.metadata.reentrant_codegen.CodegenPartial.get_modified_module_code:1: WARNING: py:class reference target not found: libcst._nodes.statement.BaseStatement /usr/lib/python3.8/site-packages/libcst/metadata/reentrant_codegen.py:docstring of libcst.metadata.reentrant_codegen.CodegenPartial.get_modified_module_bytes:1: WARNING: py:class reference target not found: libcst._nodes.statement.BaseStatement /home/tkloczko/rpmbuild/BUILD/LibCST-0.4.9/docs/source/tutorial.ipynb:: WARNING: unknown node type: > failed Traceback (most recent call last): File "/usr/lib/python3.8/site-packages/sphinx/cmd/build.py", line 281, in build_main app.build(args.force_all, args.filenames) File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 347, in build self.builder.build_update() File "/usr/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 307, in build_update self.build(['__all__'], to_build) File "/usr/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 376, in build self.write(docnames, list(updated_docnames), method) File "/usr/lib/python3.8/site-packages/sphinx/util/__init__.py", line 527, in wrapper return f(*args, **kwargs) File "/usr/lib/python3.8/site-packages/sphinx/builders/manpage.py", line 98, in write docwriter.write(largetree, destination) File "/usr/lib/python3.8/site-packages/docutils/writers/__init__.py", line 78, in write self.translate() File "/usr/lib/python3.8/site-packages/sphinx/writers/manpage.py", line 31, in translate self.document.walkabout(visitor) File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 199, in walkabout if child.walkabout(visitor): File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 199, in walkabout if child.walkabout(visitor): File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 199, in walkabout if child.walkabout(visitor): [Previous line repeated 4 more times] File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 212, in walkabout visitor.dispatch_departure(self) File "/usr/lib/python3.8/site-packages/sphinx/util/docutils.py", line 585, in dispatch_departure super().dispatch_departure(node) File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 2046, in dispatch_departure return method(node) File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 2068, in unknown_departure raise NotImplementedError( NotImplementedError: departing unknown node type: CodeAreaNode Exception occurred: File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 2068, in unknown_departure raise NotImplementedError( NotImplementedError: departing unknown node type: CodeAreaNode The full traceback has been saved in /tmp/sphinx-err-0eza3i8a.log, if you want to report the issue to the developers. Please also report this if it was a user error, so that a better error message can be provided next time. A bug report can be filed in the tracker at . Thanks! [tkloczko@devel-g2v SPECS]$ cat /tmp/sphinx-err-0eza3i8a.log # Sphinx version: 5.3.0 # Python version: 3.8.15 (CPython) # Docutils version: 0.18.1 release # Jinja2 version: 3.1.1 # Last messages: # parser # nodes # visitors # metadata # matchers # codemods # helpers # experimental # } # failed # Loaded extensions: # sphinx.ext.mathjax (5.3.0) from /usr/lib/python3.8/site-packages/sphinx/ext/mathjax.py # sphinxcontrib.applehelp (1.0.2) from /usr/lib/python3.8/site-packages/sphinxcontrib/applehelp/__init__.py # sphinxcontrib.devhelp (1.0.2) from /usr/lib/python3.8/site-packages/sphinxcontrib/devhelp/__init__.py # sphinxcontrib.htmlhelp (2.0.0) from /usr/lib/python3.8/site-packages/sphinxcontrib/htmlhelp/__init__.py # sphinxcontrib.serializinghtml (1.1.5) from /usr/lib/python3.8/site-packages/sphinxcontrib/serializinghtml/__init__.py # sphinxcontrib.qthelp (1.0.3) from /usr/lib/python3.8/site-packages/sphinxcontrib/qthelp/__init__.py # alabaster (0.7.12) from /usr/lib/python3.8/site-packages/alabaster/__init__.py # nbsphinx (0.8.9) from /usr/lib/python3.8/site-packages/nbsphinx.py # sphinx.ext.autodoc.preserve_defaults (5.3.0) from /usr/lib/python3.8/site-packages/sphinx/ext/autodoc/preserve_defaults.py # sphinx.ext.autodoc.type_comment (5.3.0) from /usr/lib/python3.8/site-packages/sphinx/ext/autodoc/type_comment.py # sphinx.ext.autodoc.typehints (5.3.0) from /usr/lib/python3.8/site-packages/sphinx/ext/autodoc/typehints.py # sphinx.ext.autodoc (5.3.0) from /usr/lib/python3.8/site-packages/sphinx/ext/autodoc/__init__.py # sphinx.ext.autosummary (5.3.0) from /usr/lib/python3.8/site-packages/sphinx/ext/autosummary/__init__.py # sphinx.ext.graphviz (5.3.0) from /usr/lib/python3.8/site-packages/sphinx/ext/graphviz.py # sphinx.ext.intersphinx (5.3.0) from /usr/lib/python3.8/site-packages/sphinx/ext/intersphinx.py # sphinx.ext.viewcode (5.3.0) from /usr/lib/python3.8/site-packages/sphinx/ext/viewcode.py # sphinx_rtd_theme (unknown version) from /usr/lib/python3.8/site-packages/sphinx_rtd_theme/__init__.py Traceback (most recent call last): File "/usr/lib/python3.8/site-packages/sphinx/cmd/build.py", line 281, in build_main app.build(args.force_all, args.filenames) File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 347, in build self.builder.build_update() File "/usr/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 307, in build_update self.build(['__all__'], to_build) File "/usr/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 376, in build self.write(docnames, list(updated_docnames), method) File "/usr/lib/python3.8/site-packages/sphinx/util/__init__.py", line 527, in wrapper return f(*args, **kwargs) File "/usr/lib/python3.8/site-packages/sphinx/builders/manpage.py", line 98, in write docwriter.write(largetree, destination) File "/usr/lib/python3.8/site-packages/docutils/writers/__init__.py", line 78, in write self.translate() File "/usr/lib/python3.8/site-packages/sphinx/writers/manpage.py", line 31, in translate self.document.walkabout(visitor) File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 199, in walkabout if child.walkabout(visitor): File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 199, in walkabout if child.walkabout(visitor): File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 199, in walkabout if child.walkabout(visitor): [Previous line repeated 4 more times] File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 212, in walkabout visitor.dispatch_departure(self) File "/usr/lib/python3.8/site-packages/sphinx/util/docutils.py", line 585, in dispatch_departure super().dispatch_departure(node) File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 2046, in dispatch_departure return method(node) File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 2068, in unknown_departure raise NotImplementedError( ```

Expected Results

sphinx-build should generate man page.

Environment Info

kloczek commented 1 year ago

List of modiules installed in build env

```console Package Version ----------------------------- ----------------- alabaster 0.7.12 appdirs 1.4.4 asttokens 2.0.5 attrs 22.1.0 Babel 2.11.0 backcall 0.2.0 beautifulsoup4 4.11.1 bleach 5.0.0 Brlapi 0.8.3 build 0.9.0 charset-normalizer 3.0.0 codespell 2.2.1 contourpy 1.0.5 cssselect 1.1.0 cycler 0.11.0 debugpy 1.6.3 decorator 5.1.1 defusedxml 0.7.1 distro 1.7.0 dnspython 2.2.1 docutils 0.18.1 entrypoints 0.4 executing 1.1.1 extras 1.0.0 fastjsonschema 2.16.1 fixtures 4.0.0 fonttools 4.38.0 gpg 1.17.1-unknown html5lib 1.1 hypothesis 6.41.0 hypothesmith 0.2.0 idna 3.4 imagesize 1.4.1 importlib-metadata 5.0.0 importlib-resources 5.9.0 iniconfig 1.1.1 ipykernel 6.17.1 ipython 8.5.0 jedi 0.18.1 Jinja2 3.1.1 jsonschema 4.17.0 jupyter_client 7.4.5 jupyter_core 5.0.0 jupyterlab-pygments 0.1.2 kiwisolver 1.4.4 lark 1.1.4 libcomps 0.1.19 libcst 0.3.20 louis 3.23.0 lxml 4.9.1 MarkupSafe 2.1.1 matplotlib 3.6.0 matplotlib-inline 0.1.5 mistune 2.0.4 mypy-extensions 0.4.3 nbclient 0.7.0 nbconvert 7.2.2 nbformat 5.7.0 nbsphinx 0.8.9 nest-asyncio 1.5.6 numpy 1.23.1 olefile 0.46 packaging 21.3 pandocfilters 1.5.0 parso 0.8.3 pbr 5.9.0 pep517 0.13.0 pexpect 4.8.0 pickleshare 0.7.5 Pillow 9.2.0 pip 22.2.2 pkgutil_resolve_name 1.3.10 platformdirs 2.5.2 pluggy 1.0.0 prompt-toolkit 3.0.29 psutil 5.9.2 ptyprocess 0.7.0 pure-eval 0.2.2 py 1.11.0 Pygments 2.13.0 PyGObject 3.42.2 pyparsing 3.0.9 pyrsistent 0.19.2 pytest 7.1.3 python-dateutil 2.8.2 pytz 2022.4 PyYAML 6.0 pyzmq 24.0.0 requests 2.28.1 rpm 4.17.0 scour 0.38.2 semantic-version 2.9.0 setuptools 65.5.1 setuptools-rust 1.5.2 setuptools-scm 7.0.5 six 1.16.0 snowballstemmer 2.2.0 sortedcontainers 2.4.0 soupsieve 2.3.2.post1 Sphinx 5.3.0 sphinx-rtd-theme 1.1.0 sphinxcontrib-applehelp 1.0.2.dev20220730 sphinxcontrib-devhelp 1.0.2.dev20220730 sphinxcontrib-htmlhelp 2.0.0 sphinxcontrib-jsmath 1.0.1.dev20220730 sphinxcontrib-qthelp 1.0.3.dev20220730 sphinxcontrib-serializinghtml 1.1.5 stack-data 0.5.1 testtools 2.5.0 tinycss2 1.2.1 tomli 2.0.1 tornado 6.2 traitlets 5.4.0 typing_extensions 4.3.0 typing-inspect 0.7.1 urllib3 1.26.12 wcwidth 0.2.5 webencodings 0.5.1 wheel 0.37.1 zipp 3.9.0 ```
benjaoming commented 1 year ago

Thanks for the report! Do you have any hints to help us understand how sphinx_rtd_theme is involved in the error tracebacks?

Does this work with an older version of sphinx_rtd_theme?

What happens if you downgrade Sphinx?

kloczek commented 1 year ago

Does this work with an older version of sphinx_rtd_theme?

What happens if you downgrade Sphinx?

I have no idea and it would a bit hard to test that form me as I've deleted in my rpm packages repo older versions of the sphinx and sphinx_rtd_theme. I'm not sure how it was befor however I'm almost sure that it was not working before but it exact error message was IIRC different and fail was in docutils code.

benjaoming commented 1 year ago

Sphinx and docutils do remove and deprecate things - is there a way for you to run this build with an older version of Sphinx?

I'm not seeing the relation to sphinx_rtd_theme here since it's not involved in building man pages. If that's correctly understood, I think you can remove it from the package's build requirements.

kloczek commented 1 year ago

My build procedures are badsing on use rpm packages so .. 😞

Other way: are you able to reproduce tht issue in you env?

benjaoming commented 1 year ago

I'm pretty sure that your traceback says this issue is happening in the manpage builder. As sphinx_rtd_theme is an HTML theme, I don't see the obvious relation.

NotImplementedError: <class 'sphinx.writers.manpage.ManualPageTranslator'> departing unknown node type: CodeAreaNode

Exception occurred:
  File "/usr/lib/python3.8/site-packages/docutils/nodes.py", line 2068, in unknown_departure
    raise NotImplementedError(
NotImplementedError: <class 'sphinx.writers.manpage.ManualPageTranslator'> departing unknown node type: CodeAreaNode
The full traceback has been saved in /tmp/sphinx-err-0eza3i8a.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

There is something happening with your usage of nbsphinx that causes this.

Please see: https://github.com/sphinx-doc/sphinx/issues/7816

kloczek commented 1 year ago

I'm pretty sure that your traceback says this issue is happening in the manpage builder. As sphinx_rtd_theme is an HTML theme, I don't see the obvious relation.

FYI ..

[tkloczko@pers-jacek SPECS]$ grep 'BuildReqires:.*python3dist(sphinx-rtd-theme)' python-*.spec -l | wc -l
105

In other words sphinx-rtd-theme is working correctly as man page generator in more than 100 other cases.

benjaoming commented 1 year ago

Interesting. But I'm not sure why any of these 105 packages would use sphinx_rtd_theme for manpages, more likely it's related to html documentation. Looking at some randmly googled source for libcst, I imagine that there's another build command that generates html outputs:

https://src.fedoraproject.org/rpms/python-libcst/blob/f34/f/python-libcst.spec#_79

kloczek commented 1 year ago

I'm not usimg Fedora. I have 1.05k packaged python modules of which almost half have documentation nbuild as man pages

[tkloczko@pers-jacek SPECS]$ ls python-*.spec| wc -l; grep %sphinx_build_man python-* | wc -l
1044
485

Man page it is still basic Unix/Linux documentation format.

benjaoming commented 1 year ago

What I'm saying is that you probably have packages that build manpages - and that Sphinx command is unrelated to sphinx_rtd_theme. You might have another command in your package build that builds HTML documentation using Sphinx's html builder - that's the one that will use sphinx_rtd_theme.

kloczek commented 1 year ago

As I wrote I'm only interesyted generate and package man pages as base format (less still is way faster on searching exact phrase on provided documentation than any web browser).

Nevertheless it is interesting that only in one case sphinx-build command fails when sphinx-rtd-theme which looks like bug in sphinx or sphinx-rtd-theme as it crashes in sphinx-rtd-theme code.

If you want you can try to reporoduce that issue in your build env by:

git cloen https://github.com/Instagram/LibCST/
cd LibCST
sphinx-build -n -T -b man docs/source build/sphinx/man

to build documenmtation it is not necessry to build that modume to build documentation.

benjaoming commented 1 year ago

They might have some part of the documentation in LibCST that isn't possible to render with the manpage builder.

Look at the use of .. only:: html in this segment: https://github.com/Instagram/LibCST/blob/987aff666466b724600a3e1c51f98f8560ceb323/docs/source/conf.py#L223-L232

I suspect your issue is similar to https://github.com/sphinx-doc/sphinx/issues/7816 and you need to find the occurrence in the LibCST documentation where they are using a directive that nbsphinx has invented that doesn't work with the manpage builder.

benjaoming commented 1 year ago

I still don't see the relation to sphinx_rtd_theme :)

If you want you can try to reporoduce that issue in your build env by:

Yes, indeed that command also gives a solid pointer to where the documentation is broken :tada: 

LibCST/docs/source/tutorial.ipynb:: WARNING: unknown node type: <CodeAreaNode: <literal_block...>>
failed
kloczek commented 1 year ago

OK thak you 👍 Wil try to open ticket against LibCST.