Improve creation of docs
[pyi2ncommon] / doc / about_docu.rst
index 0b9788d..898f0bc 100644 (file)
@@ -6,10 +6,12 @@ How to generate this documentation
 ----------------------------------
 
 * Install Sphinx
+* change dir to project main dir
+* create symlink: ``ln -s src pyi2ncommon``
 * change dir into doc
-* run sphinx-apidoc -o ./ ../src
+* run ``sphinx-apidoc -o ./ ../pyi2ncommon``
   (you may have to add a -f if you added a new module)
-* run make html
+* run ``make html``
   (this will create one .rst file for each python file in pyi2ncommon directory)