[OpenStack-docs] Navigating in RST-source docs

Lana Brindley openstack at lanabrindley.com
Thu Jun 11 21:59:11 UTC 2015


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 11/06/15 22:29, Anne Gentle wrote:
> On Thu, Jun 11, 2015 at 1:17 AM, Russell Sim
> <russell.sim at gmail.com> wrote:
> 
>> 
>> 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
>>
>>
>
>> 
> SOOO awesome. Except for the breaking arms part of course. There's
> a story there I'm sure. Thanks for the pointers!
> 
> Does anyone have time or inclination to investigate? I'm heading
> on vacation for a week but I'll also take a look and see what we
> can use.
> 
> Thank you Russell! Seems this tweet still applies. 
> https://twitter.com/annegentle/status/601472178182365185

Awesome! Thanks Russell :)

L


- -- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVegSvAAoJELppzVb4+KUy/OgH/iz/093jGV/4Fo63ZtMRKmvQ
Id+0udzz1eEHIKVcNnWXs3YRGleq0cAusmL/KzjmfWunkz3mrpOJ6U6DopLnrc93
/zKEVucxJH4L0Gi7pVE80YH/CHbTIz0UIhzDRh+nqWC6nBhEEPbMJltld9UcOSQE
MxxYZs4k69y2fMfl2Pn5zr06I86KnQDsY52YRix6eE0sh76uSKz0xB86KTtcySY+
kkrd9E4KdSP/9J78EQkb04oYr5f62+TKAdp7P3sHAf5UqbRBQjb1BBVmaAdlLpLu
j5PEsM4HPKUiw3kv/ty7RVDsHc6egxf2nu02x+1dOUx9Kis2aOKpwIguphcY6jo=
=4WI3
-----END PGP SIGNATURE-----



More information about the OpenStack-docs mailing list