[OpenStack-docs] Navigating in RST-source docs

Russell Sim russell.sim at gmail.com
Thu Jun 11 06:17:04 UTC 2015


On 5 June 2015 at 08:54, Anne Gentle <anne at openstack.org> wrote:

> On Thu, Jun 4, 2015 at 5:29 PM, Lana Brindley <openstack at lanabrindley.com>
> wrote:
>
>> -----BEGIN PGP SIGNED MESSAGE-----
>> Hash: SHA1
>>
>> Added Anne to cc. She can probably answer these questions better than
>> I can, as she was involved in the new site design.
>>
>> L
>>
>> On 05/06/15 08:13, Meg McRoberts wrote:
>> > Thanks, Lana!  Now I see them.  Not exactly where I expect these
>> > links but at leastthey are there. what about a link back to the top
>> > of the current doc? And I rather enjoy the full TOC (with current
>> > section highlighted) in the left frame, just to keep me
>> > oriented.Did you decide to get rid of this?
>
>
> We definitely want a toc that expands, just haven't found an implementer
> yet:
> https://bugs.launchpad.net/openstack-manuals/+bug/1422454
>

I can probably also help with this I spent a heap of time contributing to
the https://github.com/ryan-roemer/sphinx-bootstrap-theme/ project.

We had to do some horrible JS hacks to get the Sphinx TOCs to display as a
bootstrap element correctly.  But provided that is acceptable way to do it
i can do something similar for OpenStack?

I should also mention, that we have a bootstrap flavoured HTML writer for
Sphinx that we were building to replace the JS hacks.  I stopped work on it
after breaking my arms, but the code was written to support bootstrap 3 so
it should be easy to adapt it to the OpentStack design.  Mind you one of
the parts that was never implemented is the TOC handler.
https://github.com/ryan-roemer/sphinx-bootstrap-theme/blob/feature-custom-html-writer/sphinx_bootstrap_theme/html_bootstrap_translator.py

-- 
Cheers,
Russell Sim
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150611/a23730e0/attachment.html>


More information about the OpenStack-docs mailing list