[tor-commits] [stem/master] Drop ATTRIBUTES and PARSER_FOR_LINE from api docs
atagar at torproject.org
atagar at torproject.org
Sun Mar 1 07:16:03 UTC 2015
commit 88ddeb78ea1d079c8860c75e435ae07ed2261d4e
Author: Damian Johnson <atagar at torproject.org>
Date: Sat Feb 28 23:14:41 2015 -0800
Drop ATTRIBUTES and PARSER_FOR_LINE from api docs
These are internal constants for parsing. They're big blobs in our generated
api docs and unhelpful.
---
docs/conf.py | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/docs/conf.py b/docs/conf.py
index a12bfcf..6535135 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -231,3 +231,10 @@ man_pages = [
trac_url = 'https://trac.torproject.org/{slug}'
spec_url = 'https://gitweb.torproject.org/torspec.git/commit/?id={slug}'
+
+def skip_members(app, what, name, obj, skip, options):
+ if name in ('ATTRIBUTES', 'PARSER_FOR_LINE'):
+ return True # skip the descriptor's parser constants
+
+def setup(app):
+ app.connect('autodoc-skip-member', skip_members)
More information about the tor-commits
mailing list