[sphinx-dev] modifications to the toctree() template function

2010-08-09 Thread andreash 
Hi there,

I'm using Sphinx 1.0.1 to build some websites. While adapting the
basic template to my needs, I stumbled upon the need to modify the
toctree() template function to accomodate several things.

Most importantly, I'd like to have toctree() an option to start at the
level of the current document, and not at the root level. What I mean
is this:

root/
   doc1/
   doc2/
  doc2.1/
  doc2.2/
   doc3/

So I'd like to have the option to render a sidebar menu which only
contains the 'heading' doc2, and then the members doc2.1 and doc2.2.
I was thinking about an option toctree(startatcurrent=True) to
accomodate this ...

Also, how do I get the title of and the link to the parent of the
current document (to accomodate the 'heading' as descibed above)?

I've been searching through the Sphinx code for quite some while, but
couldn'r really figure out which functions/variables are available to
the templates. What I did find out is that probably the code that I
want is in environment.py. But how would I go to implement changes?

Any help is greatly appreciated!

Cheers, A.

-- 
You received this message because you are subscribed to the Google Groups 
sphinx-dev group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

RE: [sphinx-dev] modifications to the toctree() template function

2010-08-09 Thread Alastair Dent 
As I understand it, the toctree is built at compile time, not runtime.
So normally it is built, then inserted into the html file.

So the sidebars are built, then inserted. So what you are asking for
would be quite complicated.

I use a 'local' toctree in a similar manner to what you are asking, but
it is only in the first/overview html file for each chunk.

-Original Message-
From: sphinx-dev@googlegroups.com [mailto:sphinx-...@googlegroups.com]
On Behalf Of andreash
Sent: 09 August 2010 09:57
To: sphinx-dev
Subject: [sphinx-dev] modifications to the toctree() template function

Hi there,

I'm using Sphinx 1.0.1 to build some websites. While adapting the
basic template to my needs, I stumbled upon the need to modify the
toctree() template function to accomodate several things.

Most importantly, I'd like to have toctree() an option to start at the
level of the current document, and not at the root level. What I mean
is this:

root/
   doc1/
   doc2/
  doc2.1/
  doc2.2/
   doc3/

So I'd like to have the option to render a sidebar menu which only
contains the 'heading' doc2, and then the members doc2.1 and doc2.2.
I was thinking about an option toctree(startatcurrent=True) to
accomodate this ...

Also, how do I get the title of and the link to the parent of the
current document (to accomodate the 'heading' as descibed above)?

I've been searching through the Sphinx code for quite some while, but
couldn'r really figure out which functions/variables are available to
the templates. What I did find out is that probably the code that I
want is in environment.py. But how would I go to implement changes?

Any help is greatly appreciated!

Cheers, A.

-- 
You received this message because you are subscribed to the Google
Groups sphinx-dev group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.


-- 
You received this message because you are subscribed to the Google Groups 
sphinx-dev group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.