#7855 Upgrade docutils, Pygments and Babel, so docs can be built easily

v1.3.0
closed
Heith Seewald
sf-2 (994)
General
Dave Brondsema
2015-08-20
2015-03-16
Dave Brondsema
No

Building our docs requires pip install Sphinx and the latest version of Sphinx uses significantly newer versions of docutils, Pygments, and Babel than Allura itself uses. Allura doesn't work with the newer versions. We should update Allura to use those versions, so that there is no difficulty in running Allura and building its docs with the same virtualenv.

Discussion

  • Dave Brondsema

    Dave Brondsema - 2015-03-23
    • labels: --> sf-current, sf-2
     

  • Heith Seewald - 2015-04-02
    • status: open --> in-progress
     

  • Heith Seewald - 2015-04-02
    • Reviewer: Heith Seewald
     

  • Dave Brondsema

    Dave Brondsema - 2015-04-03
    • assigned_to: Heith Seewald
    • Reviewer: Heith Seewald --> nobody
     

  • Heith Seewald - 2015-04-03

    This ticket involves updating a 3rd party package (pypeline) to support newer versions of docutils.

    To QA this ticket:

    1. QA and merge [#1] Add support for newer versions of docutils from the pypeline tracker
    2. Install the new pypeline package
    3. Install the newest version of sphinx
    4. Run allura tests (specifically allura.tests.unit.test_repo:TestBlob)
     

  • Heith Seewald - 2015-04-03
    • status: in-progress --> review
     

  • Dave Brondsema

    Dave Brondsema - 2015-04-06
    • status: review --> in-progress
    • Reviewer: Dave Brondsema
     

  • Dave Brondsema

    Dave Brondsema - 2015-04-06

    With new Pygments package, am getting this test failure:

    FAIL: test_render (allura.tests.test_utils.TestLineAnchorCodeHtmlFormatter)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/dbrondsema/dbrondsema-4044/forge/Allura/allura/tests/test_utils.py", line 204, in test_render
    assert '<span class="lineno">1</span>' in hl_code
AssertionError

    Should also manually check syntax highlighting in markdown, code repos, and diffs. (I haven't yet)

     

  • Heith Seewald - 2015-04-14
    • status: in-progress --> review
     

  • Heith Seewald - 2015-04-14

    Good catch, thanks Dave.

    Updated and ready for review.

    hs/7855
     

  • Dave Brondsema

    Dave Brondsema - 2015-04-15
    • status: review --> closed
     

  • Dave Brondsema

    Dave Brondsema - 2015-04-15

    I went ahead and updated the requirements.txt file with the new versions of pypeline and sphinx-related packages.

     

    • Heith Seewald - 2015-04-15

      Thanks Dave

       

  • Dave Brondsema

    Dave Brondsema - 2015-04-20
    • labels: sf-current, sf-2 --> sf-2
     

  • Igor Bondarenko - 2015-06-18
    • Milestone: unreleased --> asf_release_1.3.0
     

Log in to post a comment.