Skip to content

Commit caec1fb

Browse files
committed
README: document the documentation
1 parent e0b69e5 commit caec1fb

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,15 @@ Under bitcoin/tests using test data from Bitcoin Core. To run them:
110110
python -m unittest discover && python3 -m unittest discover
111111

112112
Please run the tests on both Python2 and Python3 for your pull-reqs!
113+
114+
115+
Documentation
116+
-------------
117+
118+
Sphinx documentation is in the "doc" subdirectory. Run "make help" from there
119+
to see how to build. You will need the Python "sphinx" package installed.
120+
121+
Currently this is just API documentation generated from the code and
122+
docstrings. Higher level written docs would be useful, perhaps starting with
123+
much of this README. Pages are written in reStructuredText and linked from
124+
index.rst.

0 commit comments

Comments
 (0)