status-im/PyGithub
1
0
Fork 0
mirror of https://github.com/status-im/PyGithub.git synced 2026-09-02 03:41:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

First draft of generated documentation (issue #82)

Browse Source 
1) ./generateDocstrings.py
2) cd doc
3) make html
4) open doc/build/html/index.html
This commit is contained in:
Vincent Jacques
2012-09-13 23:10:44 +02:00
parent 9d6e22ce16
commit dc96905c05
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/index.rst
+5
View File
@@ -20,3 +20,8 @@ Indices and tables
* :ref:`modindex`
* :ref:`search`
.. automodule:: github.Github
:members:
.. automodule:: github.Organization
:members:
generateDocstrings.py
+2 -1
View File
@@ -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()
] + [