restructuredtext Questions
5
I want to do multiple versions of a documentation, which differ in the sections that are included. To achieve this I would usually use either the only directive or the ifconfig extension. However, ...
Heliometer asked 21/2, 2013 at 12:7
4
Solved
In Sphinx I get a ton of warnings like:
/PATH/FILENAME:LINE: WARNING: duplicate label LABELNAME, other instance in /PATH/FILENAME
It seems to see all section titles as "label"s and there...
Nurse asked 29/6, 2020 at 4:45
6
Solved
How can I make a non-breaking space in reStructuredText?
An obvious but problematic solution is:
`word A`
But it might be treated differently by different implementations, such as rst2latex or ...
Guidepost asked 6/8, 2012 at 14:25
7
I am working on a simple checklist using reStructuredText. To this end I use a bullet list, but I would like to replace the standard bullet points with custom signs, such as empty checkboxes. Optim...
Ezzo asked 1/8, 2011 at 21:15
2
Solved
I'm aware of the documentation regarding implicit hyperlinks in the reStructuredText manual, but I'm wondering if it is possible to reference a section without having to repeat the full section tit...
Diazo asked 25/1, 2016 at 10:27
2
Solved
How can I make a part of a word bold in reStructuredText?
Here is an example of what I need: ".rst stands for restructured text."
Horripilate asked 7/10, 2012 at 18:19
2
Solved
How can I create a linked image with reStructuredText?
I've found
.. image:: /path/to/image.jpg
for images, and external hyperlinks like
'Python <http://www.python.org/>'_
for links, ...
Manoff asked 30/12, 2012 at 2:28
3
Solved
For a programming language documentation project written in reStructuredText and rendered to HTML with Sphinx, I want to group my functions into logical groups like: String (all string functions), ...
Bedim asked 9/8, 2013 at 11:54
5
Solved
I'm getting the warning:
WARNING: document isn't included in any toctree
for files that exist in the document because they've been explicitly included. So I have the index file:
.. toctree::
:max...
Torques asked 6/3, 2013 at 14:2
1
Solved
I am using Sphinx to document a Python project, which has the structure tree depicted below.
calculator
| set_rho_and_f.py
| set_rho_and_V_dot.py
|
├───data
│ ├───fans
│ │ ...
│ │
│ ├───functions
│...
Calves asked 3/7, 2023 at 10:56
3
How can I cross-reference an indexed item inside a reStructuredText document?
For example, how can I cross-reference SectionB:
.. index::
pair: SectionA; SectionB
SectionB
--------
SectionB de...
Merit asked 19/3, 2010 at 18:0
5
Solved
I want to open a link in a new window using reStucturedText. Is this possible?
This opens link in the same window:
You can `check your location here. <http://geoiptool.com>`_
Vampire asked 30/7, 2012 at 7:6
2
My question is a follow up to How to parse restructuredtext in python? where @mbdevpl provided code for parsing the file into a tree and doing some processing on the tree.
I want to autoformat Pyth...
Acrobatics asked 24/2, 2021 at 14:44
4
Solved
Is there any module that can parse restructuredtext into a tree model?
Can docutils or sphinx do this?
Spacious asked 14/10, 2012 at 15:5
2
Solved
I'm used to write Rest documents while I never used LaTex.
What I would like to do is create some font color roles that I can add inline the text (e.g. :red:this text is red) that work both in htm...
Leilaleilah asked 16/8, 2015 at 8:22
3
Solved
I am looking at this snippet of code:
def ook(*args):
"""Some silly function.
:param *args: Optional arguments.
"""
...
And as soon as I run Sphinx, I get the oh-so helpful error:
WARNING:...
Simmers asked 26/5, 2015 at 9:23
5
Solved
I want to make multiple columns on my documentation.
Globally, i would like to do something similar as this homepage, where there is 3 columns : one with current release, one with news & updat...
Tapping asked 25/6, 2019 at 8:21
7
Solved
I am using Sphinx to generate the documentation for a project of mine.
In this project, I describe a list of available commands in a yaml file which, once loaded, results in a dictionary in the f...
Wardship asked 30/8, 2011 at 22:46
8
Solved
I uploaded a package to PyPi using:
python setup.py register -r pypi
python setup.py sdist upload -r pypi
I'm trying to modify the description, I wrote (please don't edit the formatting of the f...
Parrie asked 4/11, 2014 at 14:9
8
Solved
I have simply no idea on how can I link to another document in the reST file.
I want to link a file named install.rst to my quickstart guide in a paragraph. I don't know how can I achieve this.
P...
Wonderful asked 31/5, 2016 at 19:7
1
I have an image that I want to align in README.rst file in github but giving the specs :
.. image:: Logo/PNG/respawn-logo.png
:height: 109 px
:width: 126 px
:scale: 50 %
:alt: respawn
:align:...
Crossing asked 17/12, 2015 at 20:15
2
Solved
How can I convert a file named index.md into a reStructuredText fileindex.rst without manual editing or anything?
How about vice-verse?
What is the general syntax of such changes?
Eleen asked 20/6, 2015 at 10:34
5
In my readme on GitHub I have several images that are present there in my project's source tree which I reference successfully with directives like
.. image:: ./doc/source/_static/figs/moon_probe....
Babs asked 1/2, 2017 at 15:14
4
Solved
Using rsStructuredText to generate HTML, I am trying to wrap a paragraph with an extra div element. The must contain an "id" attribute with a value I assign. Also, the must have a "class" attribute...
Liszt asked 5/10, 2010 at 14:37
6
Solved
I have Sphinx text in the following format in source code:
Line 1 Line 2 Line 3 Line 4
I would like Line 4 to be rendered in HTML on a separate physical line. Is this possible?
Bourges asked 2/1, 2019 at 4:2
© 2022 - 2025 — McMap. All rights reserved.