Thanks for your continued work, Takeshi!

Here is my feedback copied from my blog
<http://luc.lino-framework.org/blog/2018/0116.html#sphinx-1-7-beta-is-out>:

I tested it on my projects. Note that |pip install -U sphinx| doesn’t
install it, I had to pull the github repo and use |pip install -e|. Or
did I miss something?

It worked flawlessly, except for a problem when building The Lino Book
<http://www.lino-framework.org/api/index.html#book>:

  * SphinxWarning: /book/docs/specs/cal.rst:1010:duplicate object
    description of lino_xl.lib.cal.Plugin, other instance in
    /book/docs/api/lino_xl.lib.cal.rst, use :noindex: for one of them

No, I cannot |use :noindex: for one of them| because my document
structure is based on the asumption that autodoc ignores members that
have no docstring. For example the page which documents
the|lino_xl.lib.cal|
<http://www.lino-framework.org/api/lino_xl.lib.cal.html#module-lino_xl.lib.cal> 
module
is automatically generated, but it must not contain a definition
for |lino_xl.lib.cal.Plugin|
<http://www.lino-framework.org/specs/cal.html#lino_xl.lib.cal.Plugin> which
has a prosa description in The calendar plugin
<http://www.lino-framework.org/specs/cal.html#book-specs-cal>.

It took me some time to find the reason. I first searched
for autodoc-process-docstringand autodoc_default_flags but could not
find any explanation. I added |'no-undoc-members'|, no change.

The explanation was that Sphinx didn’t consider the docstring as empty
because it took the docstring of the parent class.

The “guilty” is therefore a new configuration
setting autodoc_inherit_docstrings which default value is True. I fixed
my problem by setting it to False.

Luc


On 15/01/18 16:42, Komiya Takeshi wrote:
> Hi all,
>
> We just released 1.7.0b1.
> It includes much of improvements. And we believe it will help you.
>
> In detail, please see CHANGES:
> https://github.com/sphinx-doc/sphinx/blob/1.7.0b1/CHANGES
>
> Since this is a beta release, we expect that you may encounter bugs.
> If you find a bug, please report it on github issues:
> https://github.com/sphinx-doc/sphinx/issues
>
> Thanks,
> Takeshi KOMIYA
>

-- 
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 [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to