restructuredtext

Consider the following list in ReStructuredText : Broken list example ------------------- #. First do spam #. Then do ``eggs`` .. note:: Nobody expects the Spanish Inquisistion #. The list restarts after the note When the list is compiled in Sphinx , the number after the note are reset to 1 : Any idea how to continue the numbered list after a note section? ddbeck The discontinuity of the list is caused by the note being a standalone element, not a child of the second numbered list element. To prevent the discontinuity of the list, start the note directive at the same indentation (in this case,

When writing RST that will be processed with Sphinx , I can't get Sphinx LaTeX output to use figure numbers when referencing figures. For instance, this code: The lemmings are attacking, as can be seen in :ref:`figlem`. .. _figlem: .. figure:: _static/lemming_invasion.* They're coming! Will be converted into this: The lemmings are attacking, as can be seen in They're coming! /image goes here/ Figure 1.1: They're coming! But what I want is the "standard" LaTeX way of referencing figures, like this: The lemmings are attacking, as can be seen in Figure 1.1 How do I achieve this? The code I'm

I am using Sphinx to document a webservice that will be deployed in different servers. The documentation is full of URL examples for the user to click and they should just work. My problem is that the host, port and deployment root will vary and the documentation will have to be re-generated for every deployment. I tried defining substitutions like this: |base_url|/path .. |base_url| replace:: http://localhost:8080 But the generated HTML is not what I want (doesn't include "/path" in the generated link): <a href="http://localhost:8080">http://localhost:8080</a>/path Does anybody know how to

Is there a way to set the color of single words (or characters) in sphinx ? I'm pretty sure there should be some markup tag, like HTML's font tag. If you want to do this without being tied to html, try applying a different style than normal body text to your word. In this example adapted from the rst2pdf manual, I apply the existing rubric style which is red in the backend that I am using: Before red. .. role:: rubric I like color :rubric:`rubric`. After red. The actual look of the word will depend on how the style you choose is defined in the stylesheet that you use when generating your

How can I use color with ReStructured Text? For example, **hello** translates into <strong>hello</strong> . How can I make ReStructure(rst2html.py) translate something into <font color="####">text</font> ? I thought about ..raw:: html, but it introduces blank lines. I want to insert HTML tags without blank lines. I found this method working First, you have the role. .. role:: red An example of using :red:`interpreted text` It translates into as follows. <p>An example of using <span class="red">interpreted text</span></p> Now, you have the red class, you can use CSS for changing colors. .red {

How to insert a cross-reference in a reST/Sphinx page to either a sub-header or anchor in another page in the same documentation set? Jan Vlcinsky Ignore this answer, it does not work: Better use the answer from Louis , below For anchor, you may define "short" anchor names like this: .. _ShortAnchor: Target Header goes here ======================= Some text. To refer to that header use: For more details, see ShortAnchor_. Note, that this even expands ShortAnchor to full name of the header. You may also use full header name like: See `Target Header goes here`_ chapter. But this is more error

I'm making a framework in which I let developers describe their package using reStructuredText. I want to parse that reStructuredText into HTML so I can show it in a GUI. I'm familiar with the excellent Sphinx, but I've never otherwise parsed reStructuredText. I imagined something like a function that takes a string of reStructuredText, and possibly several additional arguments, and returns a string of HTML. So I looked into Docutils, which is responsible for parsing reStructuredText. I couldn't understand at all how to find this function. Documentation on the web is spotty. Many of the