Instead of a blog/cms, I'd like to have a static html-based site with a few (rarely updated) pages. I figure the simplest way to update them is to keep the sources in a format like ReST, and compile it each time it updates. What is a recommended compiler for this usage? I'd like to have my own theme/design and I don't need anything beyon...
I prefer to document each parameter (as needed) on the same line where I declare the parameter in order to apply D.R.Y. If I have code like this: def foo( flab_nickers, # a series of under garments to process has_polka_dots=False, needs_pressing=False # Whether the list of garments should all be pressed ): ...
While doxygen seems to be good at indexing a large C++ project, I have some major gripes with it. The generated output is ugly and poorly organized. Just finding a function in doxygen websites is generally a pain. Slow turnaround on finding markup errors. i.e. I have to index my whole project to find I used the wrong syntax on some fun...
Is there a way in rst to have automatic header numbering ? That is something like: #. Some Section =============== ... #. Some Subsection ------------------ ... #. Another Subsection --------------------- ... #. Another Section ================== ... that would be rendered as: 1. Some Section ... 1.1 Some Subsection ... 1.2 Anoth...
I am working on a reporting tool and need to generate reports in various formats including pdf, html and excel(.xls or any format which can be easily opened in excel) I am thinking of generating basic report in xhtml or restructuredtext(rst) and then converting it to other formats, I can use xhtml2pdf or rst2pdf for pdf conversion but I...
Hi, I've been documenting a software package using Sphinx and reStructuredText. Within my documents, there are some long code snippets. I want to be able to have them hidden as default, with a little "Show\Hide" button that would expand them (Example). Is there a standard way to do that? If not, I think I will suggest this feature to...
I'm trying to make this fragment work: Version History --------------- These are the versions over time:: .. include:: ../../CHANGES.txt That is, use the include directive so that a file is included as a block quote. Once inside a block quote, the directive is quoted. I want the contents of the file in a block quote. Any ide...
How can I cross-reference an indexed item inside a reStructuredText document? For example, how can I cross-reference SectionB: .. index:: pair: SectionA; SectionB SectionB -------- SectionB description. I tried using :ref:'SectionB' and :index:'SectionB' but they don't work. Thanks. ...
In restructured text, how do I write: Chapter 1: Section 1: Some section 1 text Section 1.1: An aside Section 1: Back to section 1 ...
Hi, When writing RST that will be processed with Sphinx, I can't get Sphinx LaTeX output to use figure numbers when referencing figures. For instance, this code: The lemmings are attacking, as can be seen in :ref:`figlem`. .. _figlem: .. figure:: _static/lemming_invasion.* They're coming! Will be converted into this: The l...
I have a reStructuredText document. rST uses =====, etc. as a heading format. However I need to include some lines that have this text in it, e.g.: some of my text ===== stuff ===== some more of my text And I don't want the ==== to be interpreted as a heading, i.e. I don't want stuff to be a heading. I would rather that those equal s...
My question is nearly identical to http://stackoverflow.com/questions/1227037/substitutions-inside-links-in-rest-sphinx except that I want to have text substitution within the role text. That is, I want to be able to say something like :apilink:`/search?api_key=\ |demo_api_key|\ &query=monkeys` Is there a way to do this? ...
I am a great fan of reStructuredText, however the tools that support it are scattered all over the Internet. The official tool list is incomplete and/or outdated, and can be updated only via commit privileges. For some time there was a comprehensive list at the Wikipedia reStructuredText page, but this apparently "did not meet the notabi...
I'm just learning Sphinx, and I need to edit ReST files. Is there an intelligent editor for it? Like, an editor that gives me code coloration, easy indentation, code completion (hopefully), etc. ...
I've been charged with building a documentation system/platform. Here's a short list of the major requirements: Easily localized : This will need to support a dozen or so languages out of the gate. (the ability for non-technical personnel to add/update translations would be a big plus, though not 100% required) Flexibility in output ...
Created using Sphinx 0.6.5. I know Python's documentation uses reStructuredText, but it has different sections like http://docs.python.org/whatsnew/2.6.html and http://docs.python.org/tutorial/index.html. How do you do this in reStructuredText? Do you run rst2html in a bunch of directories, keeping its structure? I know that it us...
Is there an easy way to visualize the differences between rst files using rst2pdf? I know I could use rst2latex instead and then latexdiff to generate PDF files (and that is the effect I am after), but I would like to have the same style in the original and diff files. ...
When running sphinx-build . html/ in my doc/ directory, I get the following output: $ sphinx-build . html/ Running Sphinx v0.6.4 No builder selected, using default: html loading pickled environment... done building [html]: targets for 0 source files that are out of date updating environment: 0 added, 1 changed, 0 removed reading sour...
Hello, I am using reStructured text to create some easy websites. So I have got a lot of *.rst files in which I want to add the Google Analytics code. But as far as I know it is not possible to add something like this?! I am using rst2html to convert the files to html. ...
Hi, I am generating some PDF's and I would like to disable the header on the frontpage. I know there are built-in templates in rst2pdf and one template is called coverPage but I don't seem to be able to get it to work. The manual is saying you should use a ..raw:: pdf PageBreak coverPage statement but that will insert a emp...