git.ithinksw.org
/
philo.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Added some automatic skips to autodocs. Added skeletal docs for contrib and complete...
[philo.git]
/
docs
/
conf.py
diff --git
a/docs/conf.py
b/docs/conf.py
index
043219d
..
cad16d6
100644
(file)
--- a/
docs/conf.py
+++ b/
docs/conf.py
@@
-21,6
+21,9
@@
sys.path.append(os.path.abspath(os.path.dirname(os.path.dirname(__file__))))
os.environ['DJANGO_SETTINGS_MODULE'] = 'dummy-settings'
os.environ['DJANGO_SETTINGS_MODULE'] = 'dummy-settings'
+# Import loader so that loader_tags will be correctly added to builtins. Weird import situations... this is necessary for doc build to work.
+from django.template import loader
+
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
@@
-91,6
+94,10
@@
pygments_style = 'sphinx'
#modindex_common_prefix = []
#modindex_common_prefix = []
+# Autodoc config
+autodoc_member_order = "bysource"
+
+
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
@@
-218,3
+225,11
@@
man_pages = [
('index', 'philo', u'Philo Documentation',
[u'Stephen Burrows'], 1)
]
('index', 'philo', u'Philo Documentation',
[u'Stephen Burrows'], 1)
]
+
+def skip_attribute_attrs(app, what, name, obj, skip, options):
+ if name in ("attribute_set", "get_attribute_mapper", "nodes"):
+ return True
+ return skip
+
+def setup(app):
+ app.connect('autodoc-skip-member', skip_attribute_attrs)