Stack Overflow
Stack Overflow

Questions tagged [docutils]

a general purpose document processing system written in Python.

Docutils is an open-source text processing system for processing plain text documentation into useful formats such as HTML, LaTeX, man-pages, open-document or XML. It includes the markup language.

The Docutils homepage may be found here.

180 questions
0
votes
1 answer

Distinguish document title versus section title

In the Docutils document tree, a title node may occur inside a section, or inside the document itself. For a particular Docutils NodeVisitor I am creating, I need to be able to distinguish whether the current title node is the document's title, or…
bignose
  • 30,281
  • 14
  • 77
  • 110
0
votes
2 answers

Sphinx extension: literal block with leading and/or trailing blank lines?

As far as I can tell, it is not possible to create a literal text block (e.g. with the code-block directive) that starts or ends with a blank line, because this would be ambiguous with regard to the reStructuredText syntax. That's OK. But now I want…
Matthias
  • 4,524
  • 2
  • 31
  • 50
0
votes
1 answer

How to download docutils pages with django?

I'd like to download all my documentation done with docutils into a some format (html, pdf etc) is there a way to do that easily?
Bren
  • 3,516
  • 11
  • 41
  • 73
0
votes
2 answers

Doing a sphinx extension that folds sections in the body

I try to do an extension in Sphinx, the idea would be that the extension detects the title of sections and then transform them into a fold section, ie that sphinx render a title with a prefix button that helps to display or not the content of the…
Erwan Ledoux
  • 11
  • 1
0
votes
1 answer

How to go up a level once a sub-section has been added to the document?

I have a Restructured Text document which several hierarchical sections, such as: Main title ########## Text under the main title. Sub-section =========== Text under the sub-section. This works great, I get the correct HTML formatting when I…
Edy Bourne
  • 5,679
  • 13
  • 53
  • 101
0
votes
1 answer

Convert scipy docstrings (reST) to HTML using docutils

I'm designing a filter design GUI and would like to display docstrings from Python's scipy.signal in a QTextBrowser, requiring HTML format. I think docutils should do the job for me and I tried from docutils.core import publish_string from…
Chipmuenk
  • 607
  • 1
  • 7
  • 22
0
votes
1 answer

Prevent escaping of special characters in LaTeX output

By default the LaTeX output generated by Sphinx escapes the LaTeX markup. So if I write: Normal text .. only:: latex \textbf{latex only text} After a make latexpdf call it will be Normal text textbf\{latex only text\} in LaTeX. So all chars…
Adobe
  • 12,967
  • 10
  • 85
  • 126
0
votes
1 answer

Insert figure directive in table in docutils

I am trying to make a table with some figure inside. I am asking if there is a possibility to do it in Docutils or in some other markup languages. I was trying this kind of table…
Enrico Pirani
  • 1,387
  • 3
  • 13
  • 22
0
votes
1 answer

How to use docutils to convert .rsts to htmls?

I downloaded a util(cmake,actually) tar,and it's doc was written as .rst files with structure like blow.After googling,I know docutils(a python package) can convert these files to htmls,so installed it ,but I can't find a way to to do it?please tell…
Alex Luya
  • 9,412
  • 15
  • 59
  • 91
0
votes
0 answers

sphinx: Including .eps images via raw:: latex

I would like to add an eps image within sphinx, using the raw:: latex command. I imagine something like this: .. raw:: latex \includegraphics[width = 100mm, height = 100mm]{example.eps} Running the sphinx-build command works perfectly, but…
user3691355
  • 1
0
votes
1 answer

ReST custom directive's output causes built in writer to traceback

I've written a custom ReST directive that takes input like this: .. foo:: abcdef ghijkl mnopqr a = apple; apple.png b = banana; banana.png (etc.) And outputs a table. The table is shaped like the block of letters above,…
Thanatos
  • 42,585
  • 14
  • 91
  • 146
0
votes
1 answer

Reading Django documentation with restview

I am using Fedora 18 on Virtual Box on my Windows XP desktop to learn Django. After going through the .txt documentation files, I discovered these files were written using restructuredText. I've been spending the last day or so trying to figure out…
Dave
  • 503
  • 1
  • 8
  • 21
0
votes
1 answer

Turn fields in reStructuredText into html

So I've got a reStructuredText document which includes fields: :param foo: set this to do magic and I want to turn the rST into html, with special treatment of param (and other) fields. Turning rST into html can be done with…
lost
  • 2,210
  • 2
  • 20
  • 34
0
votes
1 answer

How to know the version number of docutils

I found myself searching for the version of docutils the server was running. To my surprise, it wasn't as straight forward as typing whatever command with flag "--version". I finally got it through the commands below, but isn't it something more…
Fabien
  • 787
  • 1
  • 6
  • 11
-2
votes
1 answer

How to update a doc string in python files programatically

I have a bunch(approx 23) of .py files present in the same folder and a approx a total of 50 + functions present in each file and the respective doc strings have been updated into a csv or text file Are there any documentation utility or python…
Rams
  • 193
  • 1
  • 17
1 2 3
…
11
12