Re: [sphinx-users] autodoc reports errors for dict module variable

Hi, I think this is the same as this issue: https://github.com/sphinx-doc/sphinx/issues/8547 And there is no good way to resolve it well. Thanks, Takeshi KOMIYA 2020年10月14日(水) 16:36 Andrew Porter : > > Hello, > > I'm using autodoc in Sphinx 3.2.1 and have a problem where it reports > formatting

Re: [sphinx-users] autodoc reports errors for dict module variable

Not to worry - thanks for your time Luc. Cheers, Andy. On Thursday, 15 October 2020 at 09:11:23 UTC+1 Luc Saffre wrote: > At least one good thing: I learned about the "#:" feature (i.e. the > possibility to add documentation without actually defining a docstring). > > At the moment I have no m

Re: [sphinx-users] autodoc reports errors for dict module variable

At least one good thing: I learned about the "#:" feature (i.e. the possibility to add documentation without actually defining a docstring). At the moment I have no more quick idea. And -forgive me- I prefer to not dive deeper into this, I have so many other important things to do... Luc On 15.1

Re: [sphinx-users] autodoc reports errors for dict module variable

Thanks Luc. I discovered the "#:" on https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html (under autoattribute). Adding a docstring on the line immediately after the colour map makes no difference sadly :-( In case it helps, the rst generated by autodoc contains: - :py:data:`

Re: [sphinx-users] autodoc reports errors for dict module variable

Okay...  I think i can confirm your assumption that autodoc is trying to render the docstring of the dict class object: >>> print(dict.__doc__) dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's     (key, value) pairs dict(iterable) -> new dictionary

Re: [sphinx-users] autodoc reports errors for dict module variable

Thanks Luc. I tried adding: autodoc_inherit_docstrings = False to my conf.py, wiping all generated rst files and documentation and building again but to no avail - I still get the same warnings :-( Thanks, Andy On Wednesday, 14 October 2020 at 12:48:20 UTC+1 Luc Saffre wrote: > Try

Re: [sphinx-users] autodoc reports errors for dict module variable

Try setting autodoc_inherit_docstrings to False. Luc On 14.10.20 10:36, Andrew Porter wrote: > Hello, > > I'm using autodoc in Sphinx 3.2.1 and have a problem where it reports > formatting erro

[sphinx-users] autodoc reports errors for dict module variable

Hello, I'm using autodoc in Sphinx 3.2.1 and have a problem where it reports formatting errors from what I think is the `dict` docstring rather than my code. I have a module (`node`) which contains a dict: #: Colour map to use when writing Invoke schedule to terminal. SCHEDULE_COLOUR_M