Lots of warnings from autodoc/autosummary after upgrading to 2.1.0

Peter Quackenbush

unread,

Jun 6, 2019, 7:09:21 PM6/6/19

to sphinx-users

I've been working with statsmodels trying to get their documentation in better shape.

I was able to eliminate almost all the errors/warnings and we got when we were using sphinx 2.0.1.

An example log is here:

https://api.travis-ci.org/v3/job/542243298/log.txt

=====BEGIN======

reading sources... [ 99%] release/version0.6
reading sources... [ 99%] release/version0.7
reading sources... [ 99%] release/version0.8
reading sources... [ 99%] release/version0.9
reading sources... [ 99%] rlm
reading sources... [ 99%] rlm_techn1
reading sources... [ 99%] sandbox
reading sources... [ 99%] statespace
reading sources... [ 99%] stats
reading sources... [ 99%] tools
reading sources... [ 99%] tsa
reading sources... [100%] vector_ar

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [  0%] about
writing output... [  0%] anova
writing output... [  0%] contingency_tables
writing output... [  0%] contrasts
writing output... [  0%] datasets/dataset_proposal
writing output... [  0%] datasets/generated/anes96
writing output... [  0%] datasets/generated/cancer
writing output... [  0%] datasets/generated/ccard
writing output... [  0%] datasets/generated/china_smoking
writing output... [  0%] datasets/generated/co2
writing output... [  0%] datasets/generated/committee
writing output... [  0%] datasets/generated/copper
writing output... [  0%] datasets/generated/cpunish
writing output... [  0%] datasets/generated/elnino
writing output... [  0%] datasets/generated/engel
writing output... [  0%] datasets/generated/fair
writing output... [  0%] datasets/generated/fertility
writing output... [  0%] datasets/generated/grunfeld

=====END======

On 2.1.0, we now get a bunch of errors right after the "reading" and writing" section.

For example, see this...

https://api.travis-ci.org/v3/job/542484634/log.txt

=====BEGIN=====

reading sources... [ 99%] statespace
reading sources... [ 99%] stats
reading sources... [ 99%] tools
reading sources... [ 99%] tsa
reading sources... [100%] vector_ar

WARNING: don't know which module to import for autodocumenting 'endog_names' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'exog_names' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'endog_names' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: don't know which module to import for autodocumenting 'exog_names' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)

...

looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/travis/build/statsmodels/statsmodels/docs/source/dev/generated/statsmodels.base.model.GenericLikelihoodModel.endog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/dev/generated/statsmodels.base.model.GenericLikelihoodModel.exog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/dev/generated/statsmodels.base.model.LikelihoodModel.endog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/dev/generated/statsmodels.base.model.LikelihoodModel.exog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/dev/generated/statsmodels.base.model.Model.endog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/dev/generated/statsmodels.base.model.Model.exog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/generated/statsmodels.discrete.conditional_models.ConditionalLogit.endog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/generated/statsmodels.discrete.conditional_models.ConditionalLogit.exog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/generated/statsmodels.discrete.conditional_models.ConditionalMNLogit.endog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/generated/statsmodels.discrete.conditional_models.ConditionalMNLogit.exog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/generated/statsmodels.discrete.conditional_models.ConditionalPoisson.endog_names.rst: WARNING: document isn't included in any toctree

...

/home/travis/build/statsmodels/statsmodels/docs/source/generated/statsmodels.tsa.vector_ar.var_model.VARResults.hqic.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/generated/statsmodels.tsa.vector_ar.vecm.VECM.endog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/generated/statsmodels.tsa.vector_ar.vecm.VECM.exog_names.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [  0%] about
writing output... [  0%] anova
writing output... [  0%] contingency_tables

======END======

Does anyone have an idea as o what could be the cause of this? Likely the docs are still wrong, but not sure how best to debug.

Geert Stappers

unread,

Jun 7, 2019, 4:38:20 AM6/7/19

to sphinx...@googlegroups.com

On 07-06-2019 01:09, Peter Quackenbush wrote:

I've been working with statsmodels trying to get their documentation in better shape.

...

looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/travis/build/statsmodels/statsmodels/docs/source/dev/generated/statsmodels.base.model.GenericLikelihoodModel.endog_names.rst: WARNING: document isn't included in any toctree
/home/travis/build/statsmodels/statsmodels/docs/source/dev/generated/statsmodels.base.model.GenericLikelihoodModel.exog_names.rst: WARNING: document isn't included in any toctree

Getting warning "foo.rst isn't included in any toctree" means that file 'foo.rst' is found in the directory but that "foo" is not listed in `toctree`.

Either remove foo.rst or add it to the toctree list to get the warning resolved.

Cheers

Geert Stappers

Komiya Takeshi

unread,

Jun 7, 2019, 9:58:01 AM6/7/19

to sphinx...@googlegroups.com

Hi Peter,

Sorry for inconvenience. Are these *_names properties? If so, it must
be a bug of Sphinx-2.1.0.
https://github.com/sphinx-doc/sphinx/pull/6453
It will be released as 2.1.1 soon (maybe in this weekend).

If not, please file an issue to our issue list.

Thanks,
Takeshi KOMIYA

2019年6月7日(金) 8:09 Peter Quackenbush <pqu...@gmail.com>:

> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To post to this group, send email to sphinx...@googlegroups.com.
> Visit this group at https://groups.google.com/group/sphinx-users.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/a32961fc-be07-48e6-aadc-eb9b7423a9c3%40googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

Reply all

Reply to author

Forward