restructuredtext

I am using the Sphinx autodoc feature to generate documentation based on the docstrings of my Python library. The syntax for cross referencing is found here A label must precede the section in order to allow that section to be referenced from other areas of the documentation. What I have is a .rst (ReStructeredText) file for one of my classes. It uses .. autoclass:: classname :members: To generate documentation for the class. My question is, how would I reference the auto-generated methods of the class from another .rst document in the documentation? If I try to place a label within the method

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 form {command-name : command-description} for example: commands = {"copy" : "Copy the highlighted text in the clipboard", "paste" : "Paste the clipboard text to cursor location", ...} What I would like to know, is if there is a method in sphinx to load the yaml file during the make html cycle, translate the python dictionary in some reStructuredText format (e.g. a definition list ) and include in my

I want to have more space between the header and the paragraph and between the paragraphs. I doesn't want this to be a global setting but I want to use it where and when required. Appreciate any suggestions. You can use vertical bars at the beginning of lines to produce blank lines in the output. Like this: Heading ------- | | Paragraph with text. I just had this problem and as davidjb pointed out, using | gives you too much space on LaTeX output. This is how I solved it. Define the following: .. |vspace| raw:: latex \vspace{5mm} Then you can just use |vspace| on the places where you want the

Is it possible to strike text through in Restructured Text? Something that for example renders as a <strike> tag when converted to HTML, like: ReSTructuredText gozzilli I checked the docs better, as suggested by Ville Säävuori, and I decided to add the strikethrough like this: .. role:: strike :class: strike In the document, this can be applied as follows: :strike:`This text is crossed out` Then in my css file I have an entry: .strike { text-decoration: line-through; } There is at least three ways of doing it: .. role:: strike An example of :strike:`strike through text`. .. container:: strike