Top "Restructuredtext" questions

reStructuredText is a lightweight markup language intended to be highly readable in source format.

Have the same README both in Markdown and reStructuredText

I have a project hosted on GitHub. For this I have written my README using the Markdown syntax in order …

python github markdown restructuredtext pypi
sphinx, restructuredtext: set color for a single word

Is there a way to set the color of single words (or characters) in sphinx? I'm pretty sure there should …

html python-sphinx restructuredtext
Include my markdown README into Sphinx

I would like to include my project's README.md into my Sphinx documentation like in Can sphinx link to documents …

python markdown python-sphinx restructuredtext
Multi-line description of a parameter description in python docstring

So, reStructuredText is the recommended way for Python code documentation, if you try hard enough, you can find in the …

python coding-style python-sphinx restructuredtext docstring
How to include a local table of contents into Sphinx doc?

How to include a local table of contents into Sphinx doc? I tried .. toc:: But that doesn't seem to have …

python python-sphinx restructuredtext tableofcontents
How do I document :rtype: for a function that returns multiple possible data types?

In a Python docstring how should one document the :rtype: for a function that can return multiple possible data types? …

python return-type restructuredtext docstring
ReST strikethrough

Is it possible to strike text through in Restructured Text? Something that for example renders as a <strike> …

restructuredtext strikethrough docutils
How to embed HTML in restructured text file?

I'm using reStructuredText and I'd like to add HTML encoding an interactive flash-type animation through the <embed> tag. …

html embedded-resource restructuredtext
Referencing figures with numbers in Sphinx and reStructuredText

When writing RST that will be processed with Sphinx, I can't get Sphinx LaTeX output to use figure numbers when …

restructuredtext python-sphinx
How to make PyPi description Markdown work?

I uploaded a package to PyPi using: python setup.py register -r pypi python setup.py sdist upload -r pypi …

python restructuredtext pypi