restructuredtext

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, but I'm embedding the PDFs inside a /docs directory for reference. I don't like :download: because it doesn't display the PDF inline in the browser which requires an extra step on the users' behalf for consumption. sphinx-build -b html does not copy any files unless they are specified in config.py hook html_static_path or html_extra_path - and even then they are dropped to the root directory or

How can I do a substitution in an admonition? For example: |p| account .. note:: **Been using |p| separately and now integrating?** In my sphinx conf.py I define a replacement rule which gets appended to the rst file prior to interpretation (at least that is how I understand it): rst_epilog = '.. |p| replace:: Labnext' My first substitution in the paragraph works without fail. However the substitution in the note directive isn't applied. Any work arounds? Thanks, Mike The substitution in the note works if you remove the strong emphasis (double asterisks). Nesting of inline markup is not

I have a similar question to this , except for Sphinx and RST. Namely, I would like to prevent text from being hyphenated at the end of the line. For example I want this: This is my long sent- ence. To be: This is my long sentence. How do I do this? Hyphenation is implemented by the stylesheet basic.css in the Sphinx theme "basic". div.body p, div.body dd, div.body li, div.body blockquote { -moz-hyphens: auto; -ms-hyphens: auto; -webkit-hyphens: auto; hyphens: auto; } You can override these styles with your own. See my answer to How do I customize Sphinx RtD Theme default search settings? Your

I'm using Sphinx to document a Python project. There seems to be a bit of inconsistency with the .. csv-table:: directive. The main issue is a new line in a cell. And my questionable mental health. The following code: .. csv-table:: :header: Header1, Header2, Header3 A, B, "These lines appear as one line, even though they are written in two lines." C, D, "| These lines appear as two lines, | but they are indented, and my OCD will simply not allow it." E, F, "| If I continue this line in another line, it will appear in a new line." G, H, "If there is a blank line between the two lines, there

I want to create several files from a single template, which differ only by a variable name. For example : (file1.rst): .. |variable| replace:: 1 .. include template.rst (template.rst) : Variable |variable| ===================== Image ------- .. image:: ./images/|variable|-image.png where of course I have an image called "./images/1-image.png". The substitution of "|variable|" by "1" works well in the title, but not in the image file name, and at compilation I get : WARNING: image file not readable: ./images/|variable|-image.png How can I get reST to make the substitution in the variable name

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 doesn't detect my templates at all. In fact, if I just remove the module.rst file from _templates/autosummary/ , it renders the whole file exactly the same way as before. I've followed this SO question to the letter. If you're interested, the full repository is on GitHub . Edit: It seems it does generate a different file, I had to delete docs/_autosummary for it to read the new template. However, now it