Short version run sphinx-apidoc -o . mymodule uncomment and modify conf.py. For this example, sys.path.insert(0, os.path.abspath(‘mymodule’)) re-run make html Long answer I can reproduce the issue with this sample module: $cat mymodule/mymodule.py def fn1(): ”’First function”’ pass def fn2(): ”’Second function”’ pass Running sphinx-quickstart produces the following tree: $tree . ├── Makefile ├── _build ├── … Read more
I was getting the same issue in Mac OS X Snow Leopard. It seems to be an issue with Terminal.app. Please add the following to your $HOME/.bash_profile export LC_ALL=en_US.UTF-8 export LANG=en_US.UTF-8 Do source $HOME/.bash_profile and try. This will solve the issue.
You can customize your html sidebar in conf.py. The default html sidebar consists of 4 templates: [‘localtoc.html’, ‘relations.html’, ‘sourcelink.html’, ‘searchbox.html’] In conf.py you could change localtoc.html to globaltoc.html like this: html_sidebars = { ‘**’: [‘globaltoc.html’, ‘relations.html’, ‘sourcelink.html’, ‘searchbox.html’] } Since this in the end this will be used in HTML files, this should work on … Read more
A solution is to use the :download: “role” (detailed in the sphinx documentation on roles). Here is a short example assuming you have a file mypdf.pdf in a directory doc. The directory doc and your rst file must be in the same directory: here is a pdf file :download:`pdf <doc/mypdf.pdf>` Note that you mustn’t put … Read more
Although Markdown supports nesting bold and italic, reStructuredText does not (this is one of the rare cases where Markdown is more powerful, as there is no way to represent bold italics in reStructuredText). https://gist.github.com/1855764
From the documenation: There are two image directives: image and figure. An image is a simple picture. A figure consists of image data (including image options), an optional caption (a single paragraph), and an optional legend (arbitrary body elements). For page-based output media, figures might float to a different position if this helps the page … Read more
To create links between different reStructuredText (.rst) files you can use the inline markup provided by sphinx. See the documentation under the heading Cross-referencing documents on top of the file you define its label .. _my-reference-label: then you can link to it from other documents using :ref:`my-reference-label`. I do not believe you need to use … Read more
If you only want to ..include:: a document in another document, without having it appear in any toctree. Add :orphan: to the top of your document to get rid of the warning. This is a File-wide metadata option. Read more from the Sphinx documentation.
This construct: Here you have |optparse.OptionParser|_. .. |optparse.OptionParser| replace:: “optparse.OptionParser“ documentation .. _optparse.OptionParser: http://docs.python.org/library/optparse.html produces this HTML (some linebreaks added): <p>Here you have <a class=”reference external” href=”http://docs.python.org/library/optparse.html”> <tt class=”docutils literal”><span class=”pre”>optparse.OptionParser</span></tt> documentation</a>. </p> I realize that this is not exactly what you asked for, but maybe it’s close enough. See also http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible.
The same thing happened to me! To fix it, go to the line in conf.py that says something like this: extensions = [‘sphinx.ext.todo’, ‘sphinx.ext.viewcode’] Yours will probably look different. Anyway, add ‘sphinx.ext.autodoc’ to the list. e.g. extensions = [‘sphinx.ext.todo’, ‘sphinx.ext.viewcode’, ‘sphinx.ext.autodoc’] If it was: extensions = [] then you’d change it to: extensions = [‘sphinx.ext.autodoc’] … Read more