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

FAQ-D: doc build, sphinx warnings #8322

Open
josef-pkt opened this issue Jun 21, 2022 · 1 comment
Open

FAQ-D: doc build, sphinx warnings #8322

josef-pkt opened this issue Jun 21, 2022 · 1 comment

Comments

@josef-pkt
Copy link
Member

(notes on doc build, sphinx warnings, put here to make it easier to find)

section title in properties of classes

example reference section in a cached property
.../statsmodels/miscmodels/ordinal_model.py:docstring of statsmodels.miscmodels.ordinal_model.OrderedResults:81: CRITICAL: Unexpected section title.

can be ignored, we have many of those
sections in docstrings of properties are removed in the class docstring, but rendered correctly in docstring of property

duplicate label, names differ only in capitalization

example: links have many duplicates with capitalized and lower case names, e.g.
/statsmodels/docs/source/generated/statsmodels.genmod.families.links.cloglog.rst:2: WARNING: duplicate label generated/statsmodels.genmod.families.links.cloglog:statsmodels.genmod.families.links.cloglog, other instance in /home/runner/work/statsmodels/statsmodels/docs/source/generated/statsmodels.genmod.families.links.CLogLog.rst

can be ignored in docbuild,
but try to avoid public, documented names of objects that only differ in capitalization

@bashtage
Copy link
Member

The property bug is annoying.

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

No branches or pull requests

2 participants