For the substitution of links extlinks is fine, for including arbitrary config values as asked in your question you can use rst_epilog for substitutions (or rst_prolog for text, that should be added on top of your .rst files): In your conf.py: my_config_value = 42 rst_epilog = ‘.. |my_conf_val| replace:: %d’ % my_config_value In your .rst … Read more
Autodoc can’t find your modules, because they are not in sys.path. You have to include the path to your modules in in the sys.path in your conf.py. Look at the top of your conf.py (just after the import of sys), there is a sys.path.insert() statement, which you can adapt. By the way: you can use … Read more
A simpler way is to add this to your conf.py: def setup(app): app.add_css_file(‘css/custom.css’) # may also be an URL Then put the file into the _static/css/ folder.
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.
Edit: as of 2021 the following answer is outdated, please use html_css_files = [] in your conf.py instead of using the application API after version 1.8 (current Sphinx version at time of writing is 4.1.1). The add_stylesheet option below has been renamed add_css_file in version 1.8, and seems more intended for Sphinx extension developers. Assumptions … Read more
Here is a way to accomplish what the OP asks for: Add an __all__ list in pkg/__init__.py: from base import Base # Or use ‘from base import *’ __all__ = [“Base”] Use .. automodule:: pkg in the .rst file. Sphinx will now output documentation where the class name is shown as pkg.Base instead of pkg.base.Base.
Yes, you can! In lieu of a symlink (which won’t work on Windows), create a stub document that has nothing in it but a .. include:: directive. I ran into this trying to link to a README file that was in the top of the source tree. I put the following in a file called … Read more
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.
This is the usual “canonical approach” to “getting started” applied to the case when your source code resides in a src directory like Project/src instead of simply being inside the Project base directory. Follows these steps: Create a docs directory in your Project directory (it’s from this docs directory the commands in the following steps … Read more
You have a module-level variable that is used as the default value of a keyword argument in a function. Sphinx displays the value (instead of the name) of that variable in the function signature. This problem is discussed in another question, and the OP has also submitted an issue ticket at GitHub about it. However, … Read more