Merge lp://staging/~jderose/filestore/docs into lp://staging/filestore
| Status: | Merged |
|---|---|
| Merged at revision: | 170 |
| Proposed branch: | lp://staging/~jderose/filestore/docs |
| Merge into: | lp://staging/filestore |
| Diff against target: |
1213 lines (+1169/-0) 8 files modified
.bzrignore (+1/-0) doc/Makefile (+130/-0) doc/conf.py (+216/-0) doc/filestore.rst (+233/-0) doc/implementation.rst (+183/-0) doc/index.rst (+46/-0) doc/make.bat (+155/-0) doc/protocol.rst (+205/-0) |
| To merge this branch: | bzr merge lp://staging/~jderose/filestore/docs |
| Related bugs: |
| Reviewer | Review Type | Date Requested | Status |
|---|---|---|---|
| David Jordan | Approve | ||
|
Review via email:
|
|||
Description of the change
This isn't perfect yet, but it's a decent start, and the dmedia hashing protocol section is pretty darn solid.
To build the docs, you'll need to install sphinx:
sudo apt-get install python-sphinx
Then checkout this branch, cd into doc/, and run `make html`:
bzr checkout lp:~jderose/filestore/docs
cd docs/doc
make html
firefox _build/
The current documentation has a few API changes that haven't yet been made, but that I decided to make over the course of writing the docs.
Unless I'm missing something, it's currently not possible to use the sphinx autodoc feature with Python3 packages, which is a bummer. I'm also not yet running doctests on this documentation (not sure you can with Python3 yet).
Still to do: we want to build these from setup.py, have them built during our daily builds, and have a new python3-
Looks good to me.