Changes

User:Humitos/SugarToolkitDocs (view source)

Revision as of 11:26, 15 July 2012

332 bytes added , 11:26, 15 July 2012

→‎Commands to get the documentation ready

Line 7: Line 7:

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

−

~~cd doc/~~

make html

Humitos

266

edits