Fuel for OpenStack

[fuel-docs] the config value 'html_add_permalinks' has type `NoneType', defaults to `unicode.'

Bug #1432153 reported by Aleksandra Fedorova
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fuel for OpenStack
Fix Released
High
Nikolay Markov
Fuel for OpenStack 6.1

Bug Description

fuel-docs master doesn't pass CI due to the following error

  the config value 'html_add_permalinks' has type `NoneType', defaults to `unicode.'

https://fuel-jenkins.mirantis.com/job/verify-fuel-docs/362/console

Aleksandra Fedorova (bookwar)
Changed in fuel:
assignee: nobody → Aleksandra Fedorova (afedorova)
Revision history for this message
Aleksandra Fedorova (bookwar) wrote :

https://fuel-jenkins.mirantis.com/job/stackforge-verify-fuel-docs/2712/console pass
https://fuel-jenkins.mirantis.com/job/verify-fuel-docs/362/console fail

Revision history for this message
Aleksandra Fedorova (bookwar) wrote :

Sphinx-1.3: Changelog

PR#314, #1150: Configuration values are now checked for their type. A warning is raised if the configured and the default value do not have the same type and do not share a common non-trivial base class.

Changed in fuel:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to fuel-docs (master)

Fix proposed to branch: master
Review: https://review.openstack.org/164433

Revision history for this message
Aleksandra Fedorova (bookwar) wrote :

Temporary workaround for CI: pip install Sphinx==1.2.2

Revision history for this message
Aleksandra Fedorova (bookwar) wrote :
Download full text (4.8 KiB)

The traceback when trying to build with Sphinx 1.3:

Traceback (most recent call last):
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/pdfbuilder.py", line 127, in write
    docwriter.write(doctree, destination)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/docutils/writers/__init__.py", line 80, in write
    self.translate()
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/pdfbuilder.py", line 621, in translate
    compressed=self.compressed)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/createpdf.py", line 562, in createPdf
    elements = self.gen_elements(self.doctree)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/basenodehandler.py", line 250, in elemdispatch
    elements = self.getelements(client, node, style)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/basenodehandler.py", line 225, in getelements
    elements = self.gather_elements(client, node, style)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/basenodehandler.py", line 205, in gather_elements
    return client.gather_elements(node, style=style)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/createpdf.py", line 391, in gather_elements
    r.extend(self.gen_elements(n, style=style))
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/basenodehandler.py", line 250, in elemdispatch
    elements = self.getelements(client, node, style)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/basenodehandler.py", line 225, in getelements
    elements = self.gather_elements(client, node, style)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/genelements.py", line 442, in gather_elements
    elements = client.gather_elements(node)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/createpdf.py", line 391, in gather_elements
    r.extend(self.gen_elements(n, style=style))
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/basenodehandler.py", line 250, in elemdispatch
    elements = self.getelements(client, node, style)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/basenodehandler.py", line 225, in getelements
    elements = self.gather_elements(client, node, style)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/genelements.py", line 442, in gather_elements
    elements = client.gather_elements(node)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/createpdf.py", line 391, in gather_elements
    r.extend(self.gen_elements(n, style=style))
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/basenodehandler.py", line 250, in elemdispatch
    elements = self.getelements(client, node, style)
  File "/home/afedorova/Work/Repos/fuel-docs_VENV/lib/python2.7/site-packages/rst2pdf/b...

Read more...

Aleksandra Fedorova (bookwar)
Changed in fuel:
importance: Critical → High
Aleksandra Fedorova (bookwar)
Changed in fuel:
status: In Progress → Confirmed
Igor Shishkin (teran)
tags: added: non-release
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to fuel-docs (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/172463

Revision history for this message
Fuel Devops McRobotson (fuel-devops-robot) wrote : Change abandoned on fuel-infra/jenkins-jobs (master)

Change abandoned by Aleksandra Fedorova <email address hidden> on branch: master
Review: https://review.fuel-infra.org/4749
Reason: https://review.openstack.org/#/c/172463/

Aleksandra Fedorova (bookwar)
Changed in fuel:
assignee: Aleksandra Fedorova (afedorova) → Fuel Python Team (fuel-python)
Dmitry Pyzhov (dpyzhov)
Changed in fuel:
assignee: Fuel Python Team (fuel-python) → Nikolay Markov (nmarkov)
Revision history for this message
Nikolay Markov (nmarkov) wrote :

Started with reporting this bug to Sphinx project itself, looks like it's their issue, not the one from rst2pdf https://github.com/sphinx-doc/sphinx/issues/1844 .

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to fuel-docs (stable/6.0)

Related fix proposed to branch: stable/6.0
Review: https://review.openstack.org/172938

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to fuel-docs (stable/5.1)

Related fix proposed to branch: stable/5.1
Review: https://review.openstack.org/172939

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to fuel-docs (stable/5.0)

Related fix proposed to branch: stable/5.0
Review: https://review.openstack.org/172940

Revision history for this message
Dmitry Pyzhov (dpyzhov) wrote :

Looks like nothing to be fixed on our side. We have to wait for fix in upstream

Changed in fuel:
status: Confirmed → Won't Fix
Revision history for this message
Aleksandra Fedorova (bookwar) wrote :

Can we merge all fixes to the repo first?

Changed in fuel:
status: Won't Fix → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to fuel-docs (stable/5.1)

Reviewed: https://review.openstack.org/172939
Committed: https://git.openstack.org/cgit/stackforge/fuel-docs/commit/?id=16bdb648ee0a1eb6f6b4e649fc60d1704520f8d4
Submitter: Jenkins
Branch: stable/5.1

commit 16bdb648ee0a1eb6f6b4e649fc60d1704520f8d4
Author: Aleksandra Fedorova <email address hidden>
Date: Fri Apr 10 18:10:06 2015 +0300

    Pin Sphinx version to 1.2.2

    This is a workaround for current issue with rst2pdf incompatible with Sphinx 1.3.1

    Change-Id: Ia3554592d79192053f0aca206238b125ed700958
    Related-Bug: #1432153

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to fuel-docs (stable/6.0)

Reviewed: https://review.openstack.org/172938
Committed: https://git.openstack.org/cgit/stackforge/fuel-docs/commit/?id=d40bcfc169f60ee0eebf64eb13b45317fc9d634d
Submitter: Jenkins
Branch: stable/6.0

commit d40bcfc169f60ee0eebf64eb13b45317fc9d634d
Author: Aleksandra Fedorova <email address hidden>
Date: Fri Apr 10 18:10:06 2015 +0300

    Pin Sphinx version to 1.2.2

    This is a workaround for current issue with rst2pdf incompatible with Sphinx 1.3.1

    Change-Id: Ia3554592d79192053f0aca206238b125ed700958
    Related-Bug: #1432153

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to fuel-docs (stable/5.0)

Reviewed: https://review.openstack.org/172940
Committed: https://git.openstack.org/cgit/stackforge/fuel-docs/commit/?id=4710afb6b0f5503335198fe983ce0321eeaf5f0d
Submitter: Jenkins
Branch: stable/5.0

commit 4710afb6b0f5503335198fe983ce0321eeaf5f0d
Author: Aleksandra Fedorova <email address hidden>
Date: Fri Apr 10 18:10:06 2015 +0300

    Pin Sphinx version to 1.2.2

    This is a workaround for current issue with rst2pdf incompatible with Sphinx 1.3.1

    Change-Id: Ia3554592d79192053f0aca206238b125ed700958
    Related-Bug: #1432153

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to fuel-docs (master)

Reviewed: https://review.openstack.org/172463
Committed: https://git.openstack.org/cgit/stackforge/fuel-docs/commit/?id=90b93f6ee7f48cd5b5d50f84b4b7ef80ed8c0f02
Submitter: Jenkins
Branch: master

commit 90b93f6ee7f48cd5b5d50f84b4b7ef80ed8c0f02
Author: Aleksandra Fedorova <email address hidden>
Date: Fri Apr 10 18:10:06 2015 +0300

    Pin Sphinx version to 1.2.2

    This is a workaround for current issue with rst2pdf incompatible with Sphinx 1.3.1

    Change-Id: Ia3554592d79192053f0aca206238b125ed700958
    Related-Bug: #1432153

Revision history for this message
Dmitry Pyzhov (dpyzhov) wrote :

Original issue is fixed. We work with fixed version of sphinx. In future either bug will be fixed in upstream or we will use another approach for work with new versions.

Changed in fuel:
status: In Progress → Fix Committed
Revision history for this message
Sebastian Kalinowski (prmtl) wrote :

Sphinx has pinned version [1] and docs are building correctly [2]

[1] https://github.com/stackforge/fuel-docs/blob/01ff2034cf28dda2f3f3960b6e93b9ea56a8dc03/requirements.txt#L1
[2] https://ci.fuel-infra.org/job/verify-fuel-docs/386/

Changed in fuel:
status: Fix Committed → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on fuel-docs (master)

Change abandoned by Aleksandra Fedorova (<email address hidden>) on branch: master
Review: https://review.openstack.org/164433

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.