Skip to content Skip to sidebar Skip to footer
Showing posts with the label Restructuredtext

Substitution In A File Name With Restructuredtext (sphinx)?

I want to create several files from a single template, which differ only by a variable name. For ex… Read more Substitution In A File Name With Restructuredtext (sphinx)?

Sphinx: Use A Different Directive For A Different Output Format

Assume you have a reStructuredText document and want to export it in two formats using Sphinx 2.x: … Read more Sphinx: Use A Different Directive For A Different Output Format

Substitution In Admonitions

How can I do a substitution in an admonition? For example: |p| account .. note:: **Been using… Read more Substitution In Admonitions

In Restructuredtext, How To Put An Inline Literal Inside Of A Hyperlink?

In my reStructuredText document, I have a section defined like so: Update the ``PATH`` Environment … Read more In Restructuredtext, How To Put An Inline Literal Inside Of A Hyperlink?

How Do I Write The Multiplication Sign In Restructuredtext (rest)?

I'm writing reST documents that will be rendered to HTML and PDF using Sphinx. My source files … Read more How Do I Write The Multiplication Sign In Restructuredtext (rest)?

Substitutions Next To Angle Brackets In Sphinx

I'm trying to use substitutions in a parsed literal block in my Sphinx documentation like this:… Read more Substitutions Next To Angle Brackets In Sphinx

What Is The Sphinx Directive For Including A Document Into Another Document?

In my documentation I have an examples directory where I can say, .. literalinclude:: examples/1_ba… Read more What Is The Sphinx Directive For Including A Document Into Another Document?

Is 3-space Indentation Required In Rest?

I'm documenting my Python code using Sphinx, and read in the Python developer's guide (and … Read more Is 3-space Indentation Required In Rest?