openstack-manuals

Need dynamic TOC built with Sphinx when using openstackdocstheme

Bug #1422454 reported by Anne Gentle
16
This bug affects 2 people
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
High
Dave Walker
openstack-manuals liberty

Bug Description

The prototype at http://openstack-homepage.bitballoon.com/docs/book# has an expanding TOC. We should try to replicate that with the Sphinx openstackdocstheme.

Anne Gentle (annegentle)
tags: added: openstackdocstheme
Anne Gentle (annegentle)
Changed in openstack-manuals:
assignee: nobody → Anne Gentle (annegentle)
Revision history for this message
Bernd Bausch (berndbausch) wrote :

Note that this bug is related to #1417291 "Plus sign appearing when numbered list followed by bulleted list". There seems to be an incomplete implementation of list expansion in docs.js, which causes the plus sign to appear where it is not expected.

OpenStack Infra (hudson-openstack)
Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
Anne Gentle (annegentle) wrote :

Partial wip: https://review.openstack.org/#/c/160354/

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstackdocstheme (master)

Reviewed: https://review.openstack.org/160354
Committed: https://git.openstack.org/cgit/openstack/openstackdocstheme/commit/?id=aa3ad86eb5ec43905e01f523604df6358e05c376
Submitter: Jenkins
Branch: master

commit aa3ad86eb5ec43905e01f523604df6358e05c376
Author: Anne Gentle <email address hidden>
Date: Sun Mar 1 23:11:10 2015 -0600

    Adds links in sidebar nav that go to docs landing page

    - Doesn't implement dyanmic toc but gives basis for improvements.

    Partial-bug: 1422454
    Change-Id: I6f7aff1bf22e8985fe24e3c7b93d725b92578fe5

Anne Gentle (annegentle)
Changed in openstack-manuals:
assignee: Anne Gentle (annegentle) → nobody
status: In Progress → Confirmed
Anne Gentle (annegentle)
tags: added: doc-builds
Tom Fifield (fifieldt)
Changed in openstack-manuals:
milestone: none → liberty
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstackdocstheme (master)

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

Changed in openstack-manuals:
assignee: nobody → Dave Walker (davewalker)
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstackdocstheme (master)

Reviewed: https://review.openstack.org/207051
Committed: https://git.openstack.org/cgit/openstack/openstackdocstheme/commit/?id=60e400ac7009d05122c8d1531b26aca4525bd53f
Submitter: Jenkins
Branch: master

commit 60e400ac7009d05122c8d1531b26aca4525bd53f
Author: Dave Walker (Daviey) <email address hidden>
Date: Wed Jul 29 14:46:31 2015 +0100

    Add sidebar dynamic TOC of content

    Switching to RST one of the first things noticed was the
    lack of sidebar navigation making it much harder to use the
    documentation.

    This change adds a table of contents (with a max deph of 1).

    Change-Id: I30b94b2a48e4fc6f14d9a9da63b90fc89193a080
    Closes-Bug: #1422454
    Signed-off-by: Dave Walker (Daviey) <email address hidden>

Changed in openstack-manuals:
status: In Progress → Fix Released
Revision history for this message
Lana (loquacity) wrote :

Further changes being tracked here: https://bugs.launchpad.net/openstack-manuals/+bug/1479562

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

Duplicates of this bug

Subscribing...

Other bug subscribers

Remote bug watches

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