Re: question regarding contents directive
On 2009-03-24, Georg Brandl wrote: > Guenter Milde schrieb: >> On 2009-03-24, Georg Brandl wrote: >>> andreash schrieb: How can I tell Sphinx that it shall not display the Heading in the contents directive? >>> Use the "local" option: >> Does this work for the "toctree" too? > "toctree" only displays the heading structure of the sub-documents anyway, > so I wouldn't know what it should do there. I would like to change the presentation of http://pylit.berlios.de/ to list the sub documents as sub headings instead of a nested itemize list, e.g. PyLit = [...] Features .. toctree:: :mindepth: 1 :maxdepth: 2 features [...] Download, Installation, Usage - .. toctree:: :mindepth: 1 :maxdepth: 2 download/index usage Documentation - .. toctree:: :mindepth: 1 :maxdepth: 2 tutorial/index examples/index --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-dev@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: question regarding contents directive
Guenter Milde schrieb: > On 2009-03-24, Georg Brandl wrote: > >> andreash schrieb: > >>> How can I tell Sphinx that it shall not display the Heading in the >>> contents directive? > >> Use the "local" option: > >> .. contents:: Übersicht >>:local: > > Does this work for the "toctree" too? "toctree" only displays the heading structure of the sub-documents anyway, so I wouldn't know what it should do there. Georg --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-dev@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: question regarding contents directive
On 2009-03-24, Georg Brandl wrote: > andreash schrieb: >> How can I tell Sphinx that it shall not display the Heading in the >> contents directive? > Use the "local" option: > .. contents:: Übersicht >:local: Does this work for the "toctree" too? Günter --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-dev@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: question regarding contents directive
andreash schrieb: > Hey there, > > I have a question regarding the .. contents:: directive. > > My document roughly looks as follows: > > > ** > My Heading > ** > > .. contents:: Übersicht > > First section > = > > First subsection > > > Second section > == > > The problem is that in the contents, the heading of the document is > also included: > > Übersicht > > * My Heading > o First section > + First subsection > o Second section > > > I think that's not really necessary, since the document is titled My > Heading, and this is very big and visible on the top of the page. > > So my question is: > > How can I tell Sphinx that it shall not display the Heading in the > contents directive? Use the "local" option: .. contents:: Übersicht :local: cheers, Georg --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-dev@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 -~--~~~~--~~--~--~---
question regarding contents directive
Hey there, I have a question regarding the .. contents:: directive. My document roughly looks as follows: ** My Heading ** .. contents:: Übersicht First section = First subsection Second section == The problem is that in the contents, the heading of the document is also included: Übersicht * My Heading o First section + First subsection o Second section I think that's not really necessary, since the document is titled My Heading, and this is very big and visible on the top of the page. So my question is: How can I tell Sphinx that it shall not display the Heading in the contents directive? Thanks for your help, Andreas --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-dev@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 -~--~~~~--~~--~--~---
