[Live-demo] RC4 Build and Docs Styles

Jody Garnett jody.garnett at gmail.com
Tue Jul 27 00:56:10 PDT 2010

On Tue, Jul 27, 2010 at 7:53 AM, Alex Mandel <tech_dev at wildintellect.com> wrote:
> Right now I'm trying to tackle the styling and linking of the sphinx


> generated html. I'm somewhat confused as to why some links are
> autoreplaced and others not (R specifically, probably a name mismatch)
> and why a Quickstart link is on the contents page but not an explicit
> link for the Description. Yes the name links but I don't think that's
> clear to the end user that they probably want to read the full
> description before the Quickstart.
> Also, any reason we aren't use the TOC feature of Sphinx for the whole
> help section?

Not quite sure to answer this one :-) So here are several answers:

- For the quickstarts I was trying to mirror the osgeo workbook done
last year; so the gutter
was used for the flyout text ( ie. sidebar).
- You could use a .. toc:: tag at the start of the page
- I kind of though the quickstarts were supposed to be quick? Thus no TOC

As for a TOC of the whole help section? Each product has its own
directory and conf.py configuration. Each conf.py reference a template
... expecting we would set up tempaltes with the appropriate branding
(OSGO project, OSGeo product in incubation, non osgeo ie plain

It could be I do not understand what is meant by the whole help section.

> I assume as I dig into sphinx I'll find some of these answers, but if
> someone already knows, please feel free to enlighten me.

Handy tip; make a copy of one of the templates; and change the conf.py
files to use it.
That way you can experiment without fear of messing up existing work.


More information about the Osgeolive mailing list