Well, i lost approximately 3.4M neurons trying to read sphinx source code (was it written by a bunch of rabbid reckless raccoons ?! so many levels of abstraction). So : make your own sphinx theme (use a 3rd party theme as a base, very easy. I use ‘readable’ theme for that) in the directory where … Read more
From the sphinx.ext.autodoc documentation: autodoc_member_order This value selects if automatically documented members are sorted alphabetical (value ‘alphabetical’), by member type (value ‘groupwise’) or by source order (value ‘bysource’). The default is alphabetical. Note that for source order, the module must be a Python module with the source code available. So somewhere in your conf.py file, … Read more
This is from the official Sphinx documentation. If you have pdfTex tool installed in your machine, all you need is: $ make latexpdf Then, the generated pdf file(s) will be under _build/latex/<PROJECT-NAME>.pdf So, the complete process from scratch would be as follows: $ pip install -U sphinx # install the package $ sphinx-quickstart # create … Read more
I’ve done it at http://reinout.vanrees.org/weblog. The key trick is to add a preprocessor step. I’ve got my blog entries in a weblog/yyyy/mm/dd/ folder structure. A script iterates through that folder structure, creating index.txt files in every directory, listing the sub-items. The normal Sphinx process then renders those index.txt files. I added a custom Sphinx processor … Read more
As mentioned here and here, Sphinx native C++ support is related to highlighting/formatting/referencing, not in-code documentation extraction breathe has developed out of the discussion that chrisdew referenced [Edit inserted below]: I tested the doxygen+breathe+sphinx toolchain on a multi-10k C++ library consisting of 10 different modules/domains. My bottom line is: not yet fully usable but keep … Read more
You can check this script that I’ve made. I think it can help you. This script parses a directory tree looking for python modules and packages and creates ReST files appropriately to create code documentation with Sphinx. It also creates a modules index. UPDATE This script is now part of Sphinx 1.1 as apidoc.
Sphinx cannot extract documentation from C++ sources in and by itself. However, there are extensions, most notably Breathe, which utilize Doxygen to extract documentation from C++. I’ve not tested any of these.
I stumbled into that problem too when installed Sphinx using pip. The problem was solved using the installation way proposed by official documentation: For Python 3: $ apt-get install python3-sphinx For Python 2: $ apt-get install python-sphinx
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.