Line 7: |
Line 7: |
| sudo yum install python-sphinx | | sudo yum install python-sphinx |
| | | |
− | * Run the command that create some configs | + | * Download the source code |
| | | |
− | cd /home/humitos/sugar-jhbuild/source/sugar-toolkit-gtk3/src/sugar3
| + | git clone gitorious@git.sugarlabs.org:~humitos/sugar-toolkit-gtk3/humitoss-sugar-toolkit-gtk3.git |
− | sphinx-apidoc --doc-author="Manuel Kaufmann" --full --doc-version="0.96" --doc-release="0.96" --doc-project="Sugar Toolkit Gtk3" --output-dir="doc" . | + | |
| + | * Create the symbolic links of imports required |
| + | |
| + | cd humitoss-sugar-toolkit-gtk3 |
| + | mkdir docs |
| + | ln -s ~/sugar-jhbuild/install/lib/python2.7/site-packages/sugar3 . |
| + | ln -s ~/sugar-jhbuild/install/lib/python2.7/site-packages/sugar . |
| + | |
| + | * Run the command that creates the sources |
| + | |
| + | sphinx-apidoc --doc-author="Manuel Kaufmann" --full --doc-version="0.96" \ |
| + | --doc-release="0.96" --doc-project="Sugar Toolkit Gtk3" \ |
| + | --output-dir="source" ../src/sugar3 |
| | | |
| * Generate the documentation | | * Generate the documentation |
| | | |
− | cd doc/
| |
| make html | | make html |
| + | |
| + | * Copy to the server |
| + | |
| + | scp -r build/html/* mkaufmann.com.ar:~/public_html/sugar-toolkit-gtk3 |
| | | |
| = OnLine Documentation = | | = OnLine Documentation = |
Line 27: |
Line 42: |
| * Read the docs: http://read-the-docs.readthedocs.org/en/latest/index.html | | * Read the docs: http://read-the-docs.readthedocs.org/en/latest/index.html |
| * Mail suggesting this: http://lists.sugarlabs.org/archive/sugar-devel/2012-July/038419.html | | * Mail suggesting this: http://lists.sugarlabs.org/archive/sugar-devel/2012-July/038419.html |
| + | * http://sphinx.pocoo.org/ext/autodoc.html |