Wemake-python-styleguide: [docs] Violation set of pages is broken: code numbers missing

Created on 5 Jun 2020  路  3Comments  路  Source: wemake-services/wemake-python-styleguide

Bug report

I used to look up rule explanations by searching the rule pages with Ctrl+F.

What's wrong

The rule numbers/codes are not rendered in docs anymore.

How is that should be

It should be possible to see the WPS codes on pages like https://wemake-python-stylegui.de/en/latest/pages/usage/violations/naming.html

bug documentation good first issue help wanted starter

All 3 comments

This happened because of sphinx update to 3.0 馃槥

I don't have it set up to test out. But, looking at the documentation, I found:

Setting None or True to the value is equivalent to giving only the option name to the directives.
https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options

So, maybe just changing this line to True will do the trick?
https://github.com/wemake-services/wemake-python-styleguide/blob/master/docs/conf.py#L113

Also, it should be changed to autodoc_default_options, as that documentation (in the paragraph above) says autodoc_default_flags is deprecated.

Fixed!
小薪懈屑芯泻 褝泻褉邪薪邪 2020-06-07 胁 20 41 49

Was this page helpful?
0 / 5 - 0 ratings