From dc96905c0573d4c1d58dcd65e094da1747d49e25 Mon Sep 17 00:00:00 2001 From: Vincent Jacques Date: Thu, 13 Sep 2012 23:10:44 +0200 Subject: [PATCH] First draft of generated documentation (issue #82) 1) ./generateDocstrings.py 2) cd doc 3) make html 4) open doc/build/html/index.html --- doc/source/index.rst | 5 +++++ generateDocstrings.py | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 3145ba76..924e2e04 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -20,3 +20,8 @@ Indices and tables * :ref:`modindex` * :ref:`search` +.. automodule:: github.Github + :members: + +.. automodule:: github.Organization + :members: diff --git a/generateDocstrings.py b/generateDocstrings.py index b041fdf5..3dc52d51 100644 --- a/generateDocstrings.py +++ b/generateDocstrings.py @@ -48,7 +48,8 @@ class Generator(): elif memberName in classDescription.methods: return [ "Please edit this generated docstring for method " + className + "." + memberName + ".", - "Calls " + ( classDescription.methods[ memberName ].verb or "WTF" ) + " " + ( classDescription.methods[ memberName ].url or "WTF" ) + "Calls " + ( classDescription.methods[ memberName ].verb or "WTF" ) + " " + ( classDescription.methods[ memberName ].url or "WTF" ), + "", ] + [ ":param " + parameterName + ": " + parameterType for parameterName, parameterType in classDescription.methods[ memberName ].parameters.items() ] + [