Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3.2.1 sphinx warnings reference target not found #929

Closed
kloczek opened this issue May 14, 2022 · 0 comments · Fixed by #1088
Closed

3.2.1 sphinx warnings reference target not found #929

kloczek opened this issue May 14, 2022 · 0 comments · Fixed by #1088

Comments

@kloczek
Copy link

kloczek commented May 14, 2022

Firs of all currently it is npt possible to use spraight sphinx-build because missing path to module in copy.py

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v4.5.0

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 332, in eval_config_file
    exec(code, namespace)
  File "/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/conf.py", line 12, in <module>
    import factory
ModuleNotFoundError: No module named 'factory'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/cmd/build.py", line 272, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 202, in __init__
    self.config = Config.read(self.confdir, confoverrides or {}, self.tags)
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 165, in read
    namespace = eval_config_file(filename, tags)
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 345, in eval_config_file
    raise ConfigError(msg % traceback.format_exc()) from exc
sphinx.errors.ConfigError: There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 332, in eval_config_file
    exec(code, namespace)
  File "/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/conf.py", line 12, in <module>
    import factory
ModuleNotFoundError: No module named 'factory'


Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 332, in eval_config_file
    exec(code, namespace)
  File "/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/conf.py", line 12, in <module>
    import factory
ModuleNotFoundError: No module named 'factory'

Thi can be fixed by patch like below

--- a/docs/conf.py~     2021-10-26 14:02:25.000000000 +0000
+++ b/docs/conf.py      2022-05-14 17:15:28.667904146 +0000
@@ -9,13 +9,12 @@
 import os
 import sys

-import factory
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
+sys.path.insert(0, os.path.abspath('..'))

+import factory

 # -- Project information -----------------------------------------------------

Tan .. on building my packages I'm using sphinx-build command with -n switch which shows warmings about missing references. These are not critical issues.
Here is the output with warnings:

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
loading intersphinx inventory from https://docs.python.org/objects.inv...
loading intersphinx inventory from https://docs.djangoproject.com/en/dev/_objects/...
loading intersphinx inventory from https://docs.sqlalchemy.org/en/latest/objects.inv...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
intersphinx inventory has moved: https://docs.sqlalchemy.org/en/latest/objects.inv -> https://docs.sqlalchemy.org/en/14/objects.inv
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 11 added, 0 changed, 0 removed
reading sources... [100%] reference
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-factory-boy.3 { introduction reference orms recipes fuzzy examples internals changelog credits ideas } /home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/introduction.rst:107: WARNING: py:meth reference target not found: factory.@sequence
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/introduction.rst:145: WARNING: py:meth reference target not found: factory.@lazy_attribute
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/introduction.rst:179: WARNING: py:meth reference target not found: factory.@lazy_attribute
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:206: WARNING: py:obj reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:216: WARNING: py:obj reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:226: WARNING: py:obj reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:231: WARNING: py:obj reference target not found: strategy
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:235: WARNING: py:obj reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:244: WARNING: py:obj reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:599: WARNING: py:obj reference target not found: strategy
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:668: WARNING: py:class reference target not found: file
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:835: WARNING: py:meth reference target not found: LazyAttribute.lazy_attribute
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:868: WARNING: py:class reference target not found: builder.Resolver
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:1127: WARNING: py:attr reference target not found: factory.SubFactory.factory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:1334: WARNING: py:attr reference target not found: builder.Resolver.factory_parent
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:1788: WARNING: py:attr reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2008: WARNING: py:mod reference target not found: factory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2016: WARNING: py:class reference target not found: factory.base.Factory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2024: WARNING: py:obj reference target not found: klass
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2024: WARNING: py:obj reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2034: WARNING: py:class reference target not found: class
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2038: WARNING: py:obj reference target not found: klass
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2038: WARNING: py:obj reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2048: WARNING: py:class reference target not found: class
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2052: WARNING: py:obj reference target not found: klass
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2052: WARNING: py:obj reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2062: WARNING: py:class reference target not found: class
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2066: WARNING: py:obj reference target not found: klass
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2066: WARNING: py:obj reference target not found: strategy
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2066: WARNING: py:obj reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2077: WARNING: py:class reference target not found: class
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2081: WARNING: py:obj reference target not found: klass
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2081: WARNING: py:obj reference target not found: size
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2091: WARNING: py:class reference target not found: class
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2100: WARNING: py:mod reference target not found: factory.random
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/reference.rst:2116: WARNING: py:meth reference target not found: random.seed
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:129: WARNING: py:class reference target not found: file
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:129: WARNING: py:class reference target not found: func
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:166: WARNING: py:class reference target not found: file
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:166: WARNING: py:class reference target not found: func
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:270: WARNING: py:attr reference target not found: associated class <factory.FactoryOptions.model
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:270: WARNING: py:class reference target not found: mongoengine.EmbeddedDocument
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:270: WARNING: py:meth reference target not found: MongoEngineFactory.create
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:322: WARNING: py:meth reference target not found: sqlalchemy.orm.session.Session.add
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:327: WARNING: py:class reference target not found: factory.base.FactoryOptions
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:342: WARNING: py:meth reference target not found: sqlalchemy.orm.session.Session.flush
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:343: WARNING: py:meth reference target not found: sqlalchemy.orm.session.Session.commit
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:351: WARNING: py:meth reference target not found: sqlalchemy.orm.query.Query.one_or_none
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/orms.rst:351: WARNING: py:meth reference target not found: sqlalchemy.orm.session.Session.add
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/recipes.rst:90: WARNING: py:class reference target not found: UserFactory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/recipes.rst:102: WARNING: py:meth reference target not found: factory.Factory._generate
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/recipes.rst:213: WARNING: py:class reference target not found: RelatedFactory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/recipes.rst:213: WARNING: py:class reference target not found: RelatedFactory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/fuzzy.rst:364: WARNING: py:obj reference target not found: factory.random.randgen
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/fuzzy.rst:364: WARNING: py:meth reference target not found: get_random_state
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/examples.rst:80: WARNING: py:class reference target not found: Account
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/examples.rst:80: WARNING: py:class reference target not found: Profile
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/internals.rst:56: WARNING: py:meth reference target not found: Factory.__call__
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/internals.rst:60: WARNING: py:meth reference target not found: Factory._generate
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/internals.rst:62: WARNING: py:meth reference target not found: Factory._generate_batch`
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/internals.rst:64: WARNING: py:meth reference target not found: Factory._generate
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/internals.rst:84: WARNING: py:meth reference target not found: FactoryOptions.instantiate
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:17: WARNING: py:meth reference target not found: factory.alchemy.SQLAlchemyModelFactory._save
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:17: WARNING: py:meth reference target not found: factory.alchemy.SQLAlchemyModelFactory._get_or_create
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:103: WARNING: py:attr reference target not found: factory.Factory.model
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:105: WARNING: py:meth reference target not found: get_random_state
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:110: WARNING: py:class reference target not found: factory.declarations.SubFactory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:128: WARNING: py:attr reference target not found: factory.fuzzy.FuzzyChoice.getter
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:130: WARNING: py:meth reference target not found: factory.faker.Faker.generate
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:132: WARNING: py:class reference target not found: factory.faker.Faker
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:154: WARNING: py:class reference target not found: factory.declarations.ParameteredAttribute
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:169: WARNING: py:class reference target not found: factory.PostGenerationDeclaration
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:291: WARNING: py:func reference target not found: django.apps.apps.get_model
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:292: WARNING: py:meth reference target not found: mogo.model.Model.new
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:401: WARNING: py:attr reference target not found: factory.Factory.FACTORY_FOR
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:402: WARNING: py:attr reference target not found: factory.Factory.ABSTRACT_FACTORY
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:403: WARNING: py:attr reference target not found: factory.Factory.FACTORY_STRATEGY
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:404: WARNING: py:attr reference target not found: factory.Factory.FACTORY_ARG_PARAMETERS
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:405: WARNING: py:attr reference target not found: factory.Factory.FACTORY_HIDDEN_ARGS
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:409: WARNING: py:attr reference target not found: factory.django.DjangoModelFactory.FACTORY_DJANGO_GET_OR_CREATE
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:413: WARNING: py:attr reference target not found: factory.alchemy.SQLAlchemyModelFactory.FACTORY_SESSION
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:435: WARNING: py:class reference target not found: mongoengine.EmbeddedDocument
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:454: WARNING: py:mod reference target not found: factory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:475: WARNING: py:class reference target not found: factory.Factory.ABSTRACT_FACTORY
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:475: WARNING: py:class reference target not found: factory.Factory.FACTORY_FOR
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:498: WARNING: py:attr reference target not found: factory.builder.Resolver.factory_parent
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:498: WARNING: py:class reference target not found: factory.builder.Resolver
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:501: WARNING: py:mod reference target not found: factory.django
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:501: WARNING: py:mod reference target not found: factory.mogo
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:530: WARNING: py:attr reference target not found: factory.django.DjangoModelFactory.FACTORY_DJANGO_GET_OR_CREATE
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:541: WARNING: py:attr reference target not found: factory.django.DjangoModelFactory.FACTORY_DJANGO_GET_OR_CREATE
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:554: WARNING: py:attr reference target not found: factory.Sequence.type
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:555: WARNING: py:attr reference target not found: factory.Factory.FACTORY_HIDDEN_ARGS
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:557: WARNING: py:attr reference target not found: factory.django.DjangoModelFactory.FACTORY_DJANGO_GET_OR_CREATE
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:566: WARNING: py:class reference target not found: factory.InfiniteIterator
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:566: WARNING: py:func reference target not found: factory.infinite_iterator
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:567: WARNING: py:class reference target not found: factory.CircularSubFactory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:571: WARNING: py:meth reference target not found: factory.Factory.set_building_function
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:571: WARNING: py:meth reference target not found: factory.Factory.set_creation_function
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:594: WARNING: py:attr reference target not found: factory.Factory.FACTORY_ARG_PARAMETERS
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:596: WARNING: py:attr reference target not found: factory.Factory.FACTORY_FOR
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:617: WARNING: py:class reference target not found: factory.InfiniteIterator
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:618: WARNING: py:class reference target not found: factory.CircularSubFactory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:622: WARNING: py:meth reference target not found: factory.Factory.set_creation_function
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:622: WARNING: py:meth reference target not found: factory.Factory.set_building_function
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:624: WARNING: py:attr reference target not found: factory.Factory.FACTORY_FOR
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:661: WARNING: py:class reference target not found: factory.CircularSubFactory
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:671: WARNING: py:class reference target not found: factory.PostGenerationDeclaration
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:705: WARNING: py:class reference target not found: factory.InfiniteIterator
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:728: WARNING: py:class reference target not found: factory.ContainerAttribute
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:738: WARNING: py:attr reference target not found: factory.Factory.FACTORY_FOR
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:751: WARNING: py:data reference target not found: factory.MOGO_BUILD
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/changelog.rst:753: WARNING: py:attr reference target not found: factory.Factory.ABSTRACT_FACTORY
/home/tkloczko/rpmbuild/BUILD/factory_boy-3.2.1/docs/ideas.rst:7: WARNING: py:class reference target not found: Factory
done
build succeeded, 114 warnings.

You can peak on fixes that kind of issues in other projects
latchset/jwcrypto#289
click-contrib/sphinx-click@abc31069

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants