restructuredtext Questions
3
Solved
I'm trying to make a document with Markdown/restructuredText which will be converted with pandoc to PDF using xelatex.
I would like to return reference to figure and tables numbers in the text bod...
Christophany asked 12/8, 2018 at 13:59
3
Solved
I want to use Sphinx's autosummary extension and templates to generate API docs recursively from docstrings. I want separate pages for each module, class, method, property and function. But it does...
Kessiah asked 3/1, 2018 at 8:57
11
Solved
Since Python 2.6, it seems the documentation is in the new reStructuredText format, and it doesn't seem very easy to build a Texinfo Info file out of the box anymore.
I'm an Emacs addict and prefe...
Johnsonian asked 28/6, 2009 at 13:11
10
Solved
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...
Looney asked 16/3, 2010 at 13:19
2
I am using Sphinx to create this table:
+---------------+---------------------+---------------------------+-------------------------------------+---------------------+
| Stakeholder | Major Value ...
Vanettavang asked 18/12, 2014 at 12:34
2
Solved
I'm using sphinx and RST to generate some tech documentation as HTML and having issues getting a local PDF reference to work as a hyperlink. I've seen people use :download: to link to local PDFs, b...
Scale asked 27/7, 2016 at 12:57
2
I'm trying to resize the images in the wiki pages and nothing is working: the images are always presented with 100% width of the page.
I tried with reStructuredText:
.. image:: image.jpeg
:heig...
Counterpunch asked 13/5, 2019 at 8:34
5
Solved
How do I transcode Python documentation strings to a GitHub readme.md file?
Even though it seems like something everyone does, I cannot seem to get a decent solution and I am assuming it should be ...
Outhaul asked 26/3, 2016 at 16:3
2
Solved
I am trying to place a bulleted list in my reST simple table, but each line of the bulleted list gets its own row:
====================== ======================= =======================
|foo.png| ...
Dalia asked 29/8, 2013 at 22:56
1
Documenting a Python module using the numpy style and generating html documentation using sphinx and the numpydoc extension, I stumbled upon a bug (or feature?) regarding bulleted lists.
In reStruc...
Germicide asked 13/7, 2016 at 9:39
1
I have a piece of text that I want to be inside of a rst literal block, but I also want to break long lines in my document that are more than 70 characters into multiple lines. Is there a way to br...
Protract asked 22/3, 2013 at 21:52
1
I inherited an existing RST document with the following structure:
DocTitle
========
Heading2
--------
Heading1
========
Note that Heading1 is a larger heading than Heading2. Due to the fact t...
Leptosome asked 25/6, 2018 at 21:1
4
Here is a solution for the same problem:
Open a link in a new window in reStructuredText
However, when the document has a lot of links (especially when the links are in a table), this solut...
Belva asked 30/8, 2014 at 14:44
2
Solved
In Markdown, one can create an inline code link like so
[`dict.update`](https://docs.python.org/3/library/stdtypes.html#dict.update)
Which renders like dict.update. How can get a similar behaviour...
Quathlamba asked 11/5, 2021 at 9:57
3
Solved
I generate a documentation from rst to pdf with latexpdf and sphinx.
How can I add some page break (=new page) in my PDF?
For now I use PageBreak but it only work with rst2pdf.
.. raw:: pdf
Pa...
Propene asked 30/9, 2014 at 12:12
2
Solved
I am using Sphinx for documenting a Python project and would like to have content from an existing .md file display inside of a .rst file.
( I have already set up my conf.py to allow for markdown)....
Petrography asked 30/8, 2017 at 18:7
3
Solved
Of course, on the web an underline denotes hyperlink, but what if I need underline which is not a hyperlink?
Uella asked 31/1, 2012 at 17:34
6
Solved
I found this question, but I don't want explicit <br>s in my cell; I just want it to line-wrap where necessary.
e.g.,
================ ============
a short sentence second cell
a much longer ...
Fluoridate asked 15/5, 2013 at 16:13
6
Solved
Is there a way to put 2 different images on the same "line", so, side-by side?
I know there is the :align: option, but if I put two images, the first with :align: left and the second with :align: ...
Gleeful asked 3/3, 2014 at 14:45
1
The restructured text document
.. sectnum:
Document Title
==============
BlaBla
First section
-------------
BlaBla
Second section
--------------
BlaBla
gets rendered like this:
1. Docume...
Cecelia asked 27/2, 2018 at 13:44
2
Solved
In python-sphinx there is the only directive, which can be used to conditionally influence the document according to its output. For instance text appears in html or latex only.
It is use like thi...
Baucom asked 12/4, 2015 at 12:39
4
I'd like to link to some URL in my Sphinx docs:
<a href="http://some.url">blah</a>
I have found something similar in the docs: http://sphinx-doc.org/ext/extlinks.html - but i...
Uppermost asked 19/6, 2013 at 10:35
3
Solved
I am trying to create a properly nested list using the following code (following Sphinx and docutils docs):
1. X
a. U
b. V
c. W
2. Y
3. Z
I expect this to result in two OLs but I get the fo...
Asyut asked 5/4, 2011 at 9:56
4
Solved
Is there a way to compose standard text roles in reStructuredText? For instance, to format a string as both literal and strong?
The following do not do what I had hoped:
**``text``**
``**text**``...
Harlen asked 29/6, 2017 at 15:39
2
Solved
I have a list item in my rst file that I would like to put a literal block into, but I am unable to get the literal block to end properly.
This is my rst:
1. Item 1 (not literal)
2. Item 2::
My...
Monique asked 14/8, 2017 at 19:43
1 Next >
© 2022 - 2024 — McMap. All rights reserved.