Sphinx, reStructuredText show\hide code snippets

Posted by Adam Matan on Stack Overflow See other posts from Stack Overflow or by Adam Matan
Published on 2010-03-16T13:19:47Z Indexed on 2010/04/01 22:53 UTC
Read the original article Hit count: 509

Filed under:

sphinx

|

restructuredtext

|

code-snippet

|

show-hide

Hi,

I've been documenting a software package using Sphinx and reStructuredText.

Within my documents, there are some long code snippets. I want to be able to have them hidden as default, with a little "Show\Hide" button that would expand them (Example).

Is there a standard way to do that? If not, I think I will suggest this feature to the developers.

Thanks,

Adam

© 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 restructuredtext

reStructuredText tool support

as seen on Stack Overflow - Search for 'Stack Overflow'
I love reStructuredText, however the tools that support it are scattered all over the Internet. The official tool list is incomplete and/or outdated, and can be updated only via commit privileges. For some time there was a comprehensive list at the Wikipedia reStructuredText page, but this apparently… >>> More
editors for tables in Sphinx/reStructuredText?

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm looking at using Sphinx / reStructuredText for documentation, and it looks very promising, except tables look like a pain to do. Is there an editor that can help? >>> More
Sphinx, reStructuredText show\hide code snippets

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I've been documenting a software package using Sphinx and reStructuredText. Within my documents, there are some long code snippets. I want to be able to have them hidden as default, with a little "Show\Hide" button that would expand them (Example). Is there a standard way to do that? If not… >>> More
How can I change from docbook to restructuredText?

as seen on Stack Overflow - Search for 'Stack Overflow'
I have a 30-ish page manual in docbook. However, working with docbook is so painful that I don't really update it. I want to switch to restructedText instead. I can't find any direct translator (the best I could find is ezComponents, but it fails on the docbook sgml). Maybe there is an indirect route… >>> More
Compare and contrast the lightweight markup languages (Textile, Markdown, and reStructuredText)

as seen on Stack Overflow - Search for 'Stack Overflow'
Please identify the most popular lightweight markup languages and compare their strengths and weaknesses. These languages should be general-purpose markup for technical prose, such as for documentation (for example, Haml doesn't count). See also: Markdown versus ReStructuredText >>> More