reStructuredText is a lightweight markup language intended to be highly readable in source format.
Questions tagged [restructuredtext]
1265 questions
0
votes
1 answer
Pandoc rst displaying control characters
I'm trying to display a code-block after a list element using RST and pandoc. My markup looks like this:
4. For the given inputs, my program produces the following output:
.. code-block::
298561404
(0,0)
john doe 4
But the rendered…

Lily Mara
- 3,859
- 4
- 29
- 48
0
votes
2 answers
Sphinx extension: literal block with leading and/or trailing blank lines?
As far as I can tell, it is not possible to create a literal text block (e.g. with the code-block directive) that starts or ends with a blank line, because this would be ambiguous with regard to the reStructuredText syntax.
That's OK.
But now I want…

Matthias
- 4,524
- 2
- 31
- 50
0
votes
1 answer
reStructuredText Hyperlink References a local pdf file
nginx_pdf_
.. _nginx_pdf: Mastering Nginx.pdf
Mastering Nginx.pdf is a local pdf file in the some directory with the rst file. I want if click the Hyperlink , Browser would open the pdf file, but this can not work. how can I make this happen

yihenghe
- 3
- 1
0
votes
0 answers
sphinx: add link to title (section) in external document that does not have a reference tag
I'm using intersphinx to add links to Django's documentation. However, most of the sections that I'd like to point to do not have reference tags like this:
.. _reference_tag:
Section Title
=============
...
They are mostly just the…

jsmedmar
- 1,025
- 10
- 21
0
votes
0 answers
how can I correct this restructured text syntax issue?
In the README.rst for blargs we see an syntactic error in the first sentence of the Quick Start section - specifically we see :class: rendered instead of only seeing Parser.
The actual code of that sentence is:
The preferred use of :class:`Parser`…

Terrence Brannon
- 4,760
- 7
- 42
- 61
0
votes
1 answer
Markdown to RST with pandoc, how to convert :any:`foo_bar`
Trying to convert the following from markdown to RST using pandoc:
Markdown:
:any:`foo_bar`
Converts to:
:any:``foo_bar``
But I would like the following:
:any:`foo_bar`
Any ideas? String replacement of `` to ` is painful as it is within a…

John Smith
- 1,077
- 6
- 21
0
votes
1 answer
Sphinx restructuredtext code appears as mailto hyperlink
I am trying to write documentation in rst and build webpages using Sphinx. The issue I am having is that code with the @ symbol in it is turned into a mailto link by Sphinx.
This is the command prompt:
pi@raspberrypi ~ $
How do I stop this?

holmeswatson
- 969
- 3
- 14
- 39
0
votes
1 answer
In reStructuredText, how does one do an 'inline' include of an external document fragment?
I have a bullet lists of hyperlinks to articles, where each article has a one-line summary. And, I would like my one-line summary to appear in the bullet list:
Thing1: This is a thing.
Thing2: This is also a thing.
Because (1) my summaries quite…

davidrmcharles
- 1,923
- 2
- 20
- 33
0
votes
1 answer
Create columned text reStructuredText
I'm trying to format a reStructuredText section to look like so:
type1 : this type4 : this type7 : this
type2 : this type5 : this type8 : this
type3 : this type6 : this type9 : this
such that I can fill the page horizontally…

Syntactic Fructose
- 18,936
- 23
- 91
- 177
0
votes
0 answers
Sphinx: How to insert something between classes using automodule?
I'm using Sphinx to auto-document Django based models with https://djangosnippets.org/snippets/2533/.
The problem I have is that classes as listed one by one. Is there any way to add a subsection before each class?
For…

WBAR
- 4,924
- 7
- 47
- 81
0
votes
1 answer
Sphinx: "Too deeply nested" when building PDF from source
I am trying to build the boto documentation from the source RST files in the boto repo.
However, a build latex from the docs folder of the source leads to a:
! LaTeX Error: Too deeply nested.
How can I fix this? Or alternatively, is there a way to…

tchakravarty
- 10,736
- 12
- 72
- 116
0
votes
1 answer
anchor reference to tag in reStructuredText (rst)
I have a script that automatically builds tables in rst using the simplified syntax, for example:
.. list-table::
:widths: 5, 32
:header-rows: 1
* - Name
- Default Value
* - numVar
- 515
* - stringVar
…
Guilherme Sena
- 117
- 7
0
votes
1 answer
in restructuredtext format, how to create a document title which is centered and not enumerated
for example
==================
Title Document
==================
will create a left aligned title with enumeration such as
Title Document
I'm loooking form something to center the title in middle of the page and remove the enumeration
Bedros
- 86
- 1
- 4
0
votes
1 answer
Visualizing rst diffs with rst2pdf
Is there an easy way to visualize the differences between rst files using rst2pdf? I know I could use rst2latex instead and then latexdiff to generate PDF files (and that is the effect I am after), but I would like to have the same style in the…
Karol
- 1,246
- 2
- 13
- 20
0
votes
1 answer
How to go up a level once a sub-section has been added to the document?
I have a Restructured Text document which several hierarchical sections, such as:
Main title
##########
Text under the main title.
Sub-section
===========
Text under the sub-section.
This works great, I get the correct HTML formatting when I…
Edy Bourne
- 5,679
- 13
- 53
- 101
I have a script that automatically builds tables in rst using the simplified syntax, for example:
.. list-table::
:widths: 5, 32
:header-rows: 1
* - Name
- Default Value
* - numVar
- 515
* - stringVar
…

Guilherme Sena
- 117
- 7
0
votes
1 answer
in restructuredtext format, how to create a document title which is centered and not enumerated
for example
==================
Title Document
==================
will create a left aligned title with enumeration such as
Title Document
I'm loooking form something to center the title in middle of the page and remove the enumeration

Bedros
- 86
- 1
- 4
0
votes
1 answer
Visualizing rst diffs with rst2pdf
Is there an easy way to visualize the differences between rst files using rst2pdf? I know I could use rst2latex instead and then latexdiff to generate PDF files (and that is the effect I am after), but I would like to have the same style in the…

Karol
- 1,246
- 2
- 13
- 20
0
votes
1 answer
How to go up a level once a sub-section has been added to the document?
I have a Restructured Text document which several hierarchical sections, such as:
Main title
##########
Text under the main title.
Sub-section
===========
Text under the sub-section.
This works great, I get the correct HTML formatting when I…

Edy Bourne
- 5,679
- 13
- 53
- 101