Excluding items from TOC in Sphinx (documenter)?

Posted by Spot on Stack Overflow See other posts from Stack Overflow or by Spot
Published on 2010-03-20T08:04:19Z Indexed on 2010/03/20 8:11 UTC
Read the original article Hit count: 210

Filed under:

sphinx

|

tableofcontents

|

documentation

I'm using sphinx to document our internal API. For each class we're listing methods and then sub-sections under each such as Description and Examples, etc.

The Table of Contents is generated automatically in the sidebar, which is great except that it lists all the sub-sections. I am looking for a way to tell Sphinx to ignore certain headings when generating the TOC.

I have scoured the docs but have not found what I need. I'm sure it's something I missed. Some advice will be appreciated.

Thanks.

© Stack Overflow or respective owner

Related posts about sphinx

Sphinx PHP search

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm doing a Sphinx search but turning up some really weird results. Any help is appreciated. So for example if I type "50", I get: 50 Cent 50 Lions 50 Foot Wave, etc. This is great, but when I search "50 Ce", I get: Ryczace Dwudziestki Spisek Bernhard Gal Cowabunga Go-Go And other crazy results… >>> More
sphinx xmlpipe2 cassandra and ruby 1.9

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I start to using cassandra and I want to index my db with sphinx. I wrote ruby script which is used as xmlpipe, and I configure sphinx to use it. source xmlsrc { type = xmlpipe2 xmlpipe_command = /usr/local/bin/ruby /home/httpd/html/app/script/sphinxpipe… >>> More
Sphinx PHP Geodist problems

as seen on Stack Overflow - Search for 'Stack Overflow'
Below is my PHP function to call nearby points using Sphinx for MySQL. There are hundreds of thousands of nearby points which to what I can tell, are being indexed by Sphinx, but simply fails silently when searching with Sphinx. Other Sphinx queries I run against other indexes work completely fine… >>> More
Problem running Thinking Sphinx with Rails 2.3.5

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I just installed Sphinx (distro: archlinux) downloading the source. Then I installed "Thinking Sphinx" plugin for Rails. I followed the official page setup and this Screencast from Ryan Bates, but when I try to index the models it gives me this error: $ rake thinking_sphinx:index (in /home/benoror/Dropbox/Proyectos/cotizahoy) Sphinx… >>> More
django error ,about django-sphinx

as seen on Stack Overflow - Search for 'Stack Overflow'
from django.db import models from djangosphinx.models import SphinxSearch class MyModel(models.Model): search = SphinxSearch() # optional: defaults to db_table # If your index name does not match MyModel._meta.db_table # Note: You can only generate automatic configurations from the ./manage… >>> More

Related posts about tableofcontents

Bitbucket Wiki TableOfContents

as seen on Stack Overflow - Search for 'Stack Overflow'
Hello guys, I started with bitbucket and tried to use the wiki for my documentation. Therefore, i created a folder "documentation" unter the folder "wiki" (same level as home.wiki) and added some .wiki files. Now i'm trying to display all these contents of Documentation/ as table of contents. Therefore… >>> More
latex undefined control sequence with tableofcontents

as seen on Stack Overflow - Search for 'Stack Overflow'
I was using \documentclass{amsmath} for awhile with no issues, but I recently wanted to switch to the normal \documentclass{article} because I thought it looked nicer. However, now my \tableofcontents command produces this error: ! Undefined control sequence. <argument> \tocsection … >>> More
hide an entry from Toc in latex.

as seen on Stack Overflow - Search for 'Stack Overflow'
hi all, i wanna know how can hide a section from table of contents but without losing the section number in the body of the document...for example in this tex i lose the number for "hide", and all the sequence is damaged. \documentclass{article} \begin{document} \tableofcontents \section{uno} \section{dos} \section*{hide} \section{tres} \end{document… >>> More
Modifying LaTeX Table of Contents to add a period after chapter/table/figure number

as seen on Stack Overflow - Search for 'Stack Overflow'
I need to add a period after the chapter/table/figure number in each line in Table of Contents/LoT/LoF. ie, right now it shows: TABLES 1 first 2 second but I need it to show: TABLES 1. first 2. second I know this can be done with the tocloft package, however, that package is conflicting… >>> More
Add table of contents to RTF document

as seen on Stack Overflow - Search for 'Stack Overflow'
I am trying to generate a RTF document by hand and eventually will do it programtically. I plan to improve pyRTF so that it can generate "Table of contents", which I think it can't. I am not able to use RTF controls words (\tc, \tcf and \tcl.) to generate a TOC. http://msdn.microsoft.com/en-us/library/aa140283(office… >>> More