Re: [sphinx-users] Sphinx-1.7.0b1 has been released

2018-01-17 Thread Luc Saffre 
Yes, that's what I missed! Thanks Shirou for the pointer.
I verified that indeed it works, and I also updated my blog entry.

Luc

On 17/01/18 04:34, shirou wrote:
> Hi,
>
> Since sphinx 1.7.0b1 is pre-release, could you try to install again
> with --pre option ?
>
> Since pip 1.4, pip does not search or install pre-release in default.
> https://pip.pypa.io/en/stable/reference/pip_install/?highlight=pre#pre-release-versions
>
>
> Thanks,
> WAKAYAMA Shirou
>
>
> 2018-01-17 3:15 GMT+09:00 Luc Saffre :
>> Thanks for your continued work, Takeshi!
>>
>> Here is my feedback copied from my blog:
>>
>> 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:
>>
>> 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 module is
>> automatically generated, but it must not contain a definition for
>> lino_xl.lib.cal.Plugin which has a prosa description in The calendar plugin.
>>
>> 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 sphinx-users+unsubscr...@googlegroups.com.
>> To post to this group, send email to sphinx-users@googlegroups.com.
>> Visit this group at https://groups.google.com/group/sphinx-users.
>>
>> For more options, visit https://groups.google.com/d/optout.


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

Re: [sphinx-users] Sphinx-1.7.0b1 has been released

2018-01-16 Thread shirou 
Hi,

Since sphinx 1.7.0b1 is pre-release, could you try to install again
with --pre option ?

Since pip 1.4, pip does not search or install pre-release in default.
https://pip.pypa.io/en/stable/reference/pip_install/?highlight=pre#pre-release-versions


Thanks,
WAKAYAMA Shirou


2018-01-17 3:15 GMT+09:00 Luc Saffre :
> Thanks for your continued work, Takeshi!
>
> Here is my feedback copied from my blog:
>
> 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:
>
> 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 module is
> automatically generated, but it must not contain a definition for
> lino_xl.lib.cal.Plugin which has a prosa description in The calendar plugin.
>
> 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 sphinx-users+unsubscr...@googlegroups.com.
> To post to this group, send email to sphinx-users@googlegroups.com.
> Visit this group at https://groups.google.com/group/sphinx-users.
>
> For more options, visit https://groups.google.com/d/optout.

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

Re: [sphinx-users] Sphinx-1.7.0b1 has been released

2018-01-16 Thread Luc Saffre 
Thanks for your continued work, Takeshi!

Here is my feedback copied from my blog
:

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
:

  * 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|
 
module
is automatically generated, but it must not contain a definition
for |lino_xl.lib.cal.Plugin|
 which
has a prosa description in The calendar plugin
.

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

[sphinx-users] Sphinx-1.7.0b1 has been released

2018-01-15 Thread Komiya Takeshi 
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 sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.