Contributing to documentation¶
You see that build script in the docs folder ? Don’t use it.
I might give the build script some attention some day and make it more useful, but for now I have other priorities.
You can find documentation in three places in this project:
- In Python docstring
- And finally in the docs/ folder
So if you submit a pull request, it’s quite easy to update the documentation for the code you are submitting. You just have to comment the code properly.
Building the Python documentation¶
cd django-editlive/docs/ make html
Using Ubuntu One is really not a requirement, just a convenience for me.
mkdir -p ~/Ubuntu\ One/SDKs/ && cd ~/Ubuntu\ One/SDKs/ wget http://jsdoc-toolkit.googlecode.com/files/jsdoc_toolkit-2.4.0.zip unzip jsdoc_toolkit-2.4.0.zip cd jsdoc_toolkit-2.4.0
cd django-editlive/ java -jar ~/Ubuntu\ One/SDKs/jsdoc_toolkit-2.4.0/jsdoc-toolkit/jsrun.jar \ ~/Ubuntu\ One/SDKs/jsdoc_toolkit-2.4.0/jsdoc-toolkit/app/run.js ./ \ --template=_themes/jsdoc-for-sphinx -x=js,jsx --directory=./jsdoc