restructuredtext

I have a table in rst, and I want to add a class to it, when compiling to HTML with Sphinx. According to the docs , adding a .. class:: directive before the table should add the class to the table, but instead it adds a definition list. The table code is: .. class:: special == == == a b c 1 2 3 == == == which results in: <dl class="class"> <dt id="special"> <em class="property">class </em><code class="descname">special</code><a class="headerlink" href="#special" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <table border="1" class="docutils"> <colgroup> <col width="33%" />

There are two version of my little tool: https://pypi.python.org/pypi/tbzuploader/2017.11.0 https://pypi.python.org/pypi/tbzuploader/2017.12.0 Bug: The pypi page looks ugly. In the last update a change in README.rst cases a warning: user@host> rst2html.py README.rst > /tmp/foo.html README.rst:18: (WARNING/2) Inline emphasis start-string without end-string. README.rst:18: (WARNING/2) Inline emphasis start-string without end-string. Now the pypi page looks ugly :-( I use this recipe to do CI, bumpversion, upload to pypi: https://github.com/guettli/github-travis-bumpversion-pypi How could I

Is there any module that can parse restructuredtext into a tree model? Can docutils or sphinx do this? Gareth Latty Docutils does indeed contain the tools to do this. What you probably want is the parser at docutils.parsers.rst See this page for details on what is involved. There are also some examples at docutils/examples.py - particularly check out the internals() function, which is probably of interest. I'd like to extend upon the answer from Gareth Latty. "What you probably want is the parser at docutils.parsers.rst " is a good starting point of the answer, but what's next? Namely: How to

I know reStructuredText has this directive: .. code:: bash gedit pohl.m which renders a code block. Is there some way to get syntax highlighting for inline snippets like this: Do edit the file, type ``gedit pohl.m`` into a terminal. The backticks mark it as code, but I'd like to highlight it with pygments like the block. Is this possible? Chris Having looked into this some more I stumbled upon the document reStructuredText Interpreted Text Roles . From this document: Interpreted text uses backquotes (`) around the text. An explicit role marker may optionally appear before or after the text,

I want to extend the theme used by Sphinx and ReadTheDocs with my own custom styles. What is the best way I can do this so that my changes will stick? Assumptions Your RTD doc set has something like the following structure: (root path) (some other stuff not germane to this discussion) _static/ _templates/ conf.py You're also building locally using sphinx-build or sphinx-autobuild using the default theme, but your deployed server might use the sphinx-rtd-theme instead. Use Case: Hatnotes For this illustration, I'm going to show how to create custom styling for "hatnotes", a concept which is

This is a followup of "ReST Strikethrough" ReST strikethrough but in a Sphinx rather than ReST context. My question is whether there is a central place in sphinx where to put a "role" directive or whether this directive really has to be repeated in every rst file within a sphinx docmentation. In more detail: It is easy to define custom CSS styles for inline text (see ReST Strikethrough as example) using a role directive: .. role:: custom :class: custom This is an :custom:`inline text`. which translates into a html rendering of .. This is an <span class="custom">inline text</span>. .. Also, a