jyapayne/llvmpy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Allow Sphinx build docs with docstrings without installing module.

Browse source
This commit is contained in:
Paul Sokolovsky 2013-02-24 00:43:43 +02:00
commit 4e87b5170a
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/source/conf.py
View file

@ -11,12 +11,22 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys, os import sys, os, glob
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.')) #sys.path.insert(0, os.path.abspath('../..'))
# Support sphinx.ext.autodoc to extract docstrings from modules without installing
# complete package.
# The python modules depend on _core, so we must build entire package first though.
built_lib = glob.glob('../../build/lib.*/')
if not built_lib:
print "WARNING: To build complete documentation you must build package first"
else:
# lib dir has platform suffix
sys.path.insert(0, os.path.abspath(built_lib[0]))
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------