Skip to content

Commit e7a574f

Browse files
committed
Updated README.md for outstanding issues and documentation
1 parent ea9f6e3 commit e7a574f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,19 @@ people who are using the bindings should go ahead and install.
4646
python setup.py install
4747
````
4848
49+
Documentation
50+
=============
51+
52+
Documentation is formatted using the [sphinx](http://sphinx-doc.org/)
53+
documentation system. The html-formatted output is under the pygetdns
54+
source tree in doc/_build/html.
55+
4956
Known issues
5057
============
5158
5259
There are several issues in this alpha release which we expect to be resolved
5360
prior to the TNW hack battle. These include:
5461
55-
* full module documentation
5662
* the asynchronous code is not actually asynchronous; it invokes the
5763
callback but the calling function blocks until the callback returns
5864
* getdns exception error strings are not "bubbling up" to the user

0 commit comments

Comments
 (0)