Postgres Pro
Downloads
Home   >   mailing lists

Thread: [psycopg] documentation build failure with python sphinx 1.6.3

[psycopg] documentation build failure with python sphinx 1.6.3

From
Pavel Raiskup
Date:
Hi all,

with recent Fedora's sphinx packages, it seems to be a problem to build the
documentation in doc/ directory:

    $ make
    make_admonition

    WARNING: couldn't import psycopg to read version.
    WARNING: couldn't import psycopg to read version.
    /usr/lib/python3.6/site-packages/sphinx/util/compat.py:40:
    RemovedInSphinx17Warning: sphinx.util.compat.Directive is deprecated and
    will be removed in Sphinx 1.7, please use docutils' instead.
    RemovedInSphinx17Warning)

    Extension error:
    Could not import extension dbapi_extension (exception: cannot import name
    'make_admonition')
    /usr/lib/python3.6/site-packages/sphinx/util/compat.py:40:
    RemovedInSphinx17Warning: sphinx.util.compat.Directive is deprecated and
    will be removed in Sphinx 1.7, please use docutils' instead.
    RemovedInSphinx17Warning)

    Extension error:
    Could not import extension dbapi_extension (exception: cannot import name
    'make_admonition')

Is there some work-around for this?  We use python-sphinx-1.6.3.

Pavel

Re: [psycopg] documentation build failure with python sphinx 1.6.3

From
Daniele Varrazzo
Date:
On Wed, Aug 16, 2017 at 7:24 AM, Pavel Raiskup <praiskup@redhat.com> wrote:

> Is there some work-around for this?  We use python-sphinx-1.6.3.

    $ cat ~/src/psycopg2/doc/requirements.txt
    # Packages only needed to build the docs
    Pygments>=1.5
    Sphinx>=1.2,<=1.3

You can use the requirements file included in the `doc` directory and
build the docs in a virtualenv.

-- Daniele

Re: [psycopg] documentation build failure with python sphinx 1.6.3

From
Pavel Raiskup
Date:
On Wednesday, August 16, 2017 1:20:08 PM CEST Daniele Varrazzo wrote:
> On Wed, Aug 16, 2017 at 7:24 AM, Pavel Raiskup <praiskup@redhat.com> wrote:
>
> > Is there some work-around for this?  We use python-sphinx-1.6.3.
>
>     $ cat ~/src/psycopg2/doc/requirements.txt
>     # Packages only needed to build the docs
>     Pygments>=1.5
>     Sphinx>=1.2,<=1.3
>
> You can use the requirements file included in the `doc` directory and
> build the docs in a virtualenv.

Ah, unfortunately we can not do this in Fedora build system -- offline build
system built solely against Fedora's packages (no external pip packages).

I disabled the build of documentation which means the doc won't be distributed
temporarily on Fedora (till the docs can be distrubuted by up2date sphinx).

Thanks,
Pavel

Re: [psycopg] documentation build failure with python sphinx 1.6.3

From
Daniele Varrazzo
Date:
On Wed, Aug 16, 2017 at 2:20 PM, Pavel Raiskup <praiskup@redhat.com> wrote:
> On Wednesday, August 16, 2017 1:20:08 PM CEST Daniele Varrazzo wrote:
>> On Wed, Aug 16, 2017 at 7:24 AM, Pavel Raiskup <praiskup@redhat.com> wrote:
>>
>> > Is there some work-around for this?  We use python-sphinx-1.6.3.
>>
>>     $ cat ~/src/psycopg2/doc/requirements.txt
>>     # Packages only needed to build the docs
>>     Pygments>=1.5
>>     Sphinx>=1.2,<=1.3
>>
>> You can use the requirements file included in the `doc` directory and
>> build the docs in a virtualenv.
>
> Ah, unfortunately we can not do this in Fedora build system -- offline build
> system built solely against Fedora's packages (no external pip packages).
>
> I disabled the build of documentation which means the doc won't be distributed
> temporarily on Fedora (till the docs can be distrubuted by up2date sphinx).

Of course if two different distros have different idea of the "up to
date package" you understand we cannot make all happy, no?

My only requirement for the documentation is that "it builds":
providing docs that can build with a range of major Sphinx versions is
outside psycopg mission. Feel free to provide a patch to build it
against a more recent sphinx if that's useful for you.


-- Daniele

Re: [psycopg] documentation build failure with python sphinx 1.6.3

From
Pavel Raiskup
Date:
On Wednesday, August 16, 2017 4:33:14 PM CEST Daniele Varrazzo wrote:
> On Wed, Aug 16, 2017 at 2:20 PM, Pavel Raiskup <praiskup@redhat.com> wrote:
> > On Wednesday, August 16, 2017 1:20:08 PM CEST Daniele Varrazzo wrote:
> >> On Wed, Aug 16, 2017 at 7:24 AM, Pavel Raiskup <praiskup@redhat.com> wrote:
> >>
> >> > Is there some work-around for this?  We use python-sphinx-1.6.3.
> >>
> >>     $ cat ~/src/psycopg2/doc/requirements.txt
> >>     # Packages only needed to build the docs
> >>     Pygments>=1.5
> >>     Sphinx>=1.2,<=1.3
> >>
> >> You can use the requirements file included in the `doc` directory and
> >> build the docs in a virtualenv.
> >
> > Ah, unfortunately we can not do this in Fedora build system -- offline build
> > system built solely against Fedora's packages (no external pip packages).
> >
> > I disabled the build of documentation which means the doc won't be distributed
> > temporarily on Fedora (till the docs can be distrubuted by up2date sphinx).
>
> Of course if two different distros have different idea of the "up to
> date package" you understand we cannot make all happy, no?

Accepted.  But I can at least mark this issue as "reported upstraem" :), as I
was not able to find any online reports so far.

> My only requirement for the documentation is that "it builds":
> providing docs that can build with a range of major Sphinx versions is
> outside psycopg mission. Feel free to provide a patch to build it against a
> more recent sphinx if that's useful for you.

+1 to moving against newer sphinx version (and forget about the older one).
Though I have no good skills to do it myself now...  I submitted bug against
Fedora package to not forget about it:
https://bugzilla.redhat.com/show_bug.cgi?id=1482492

Pavel