Improve creation of docs

Want to have the name "pyi2ncommon" in there, not have it replaced by "src".

Realized that modules.rst is auto-created, so does not belong into git.

diff --git a/.gitignore b/.gitignore
index b8336d5..582e72c 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -7,9 +7,10 @@ dist/
 MANIFEST
 _build/
 doc/_build
-doc/src.rst
-doc/src.cnfline.rst
-doc/src.cnfvar.rst
+doc/pyi2ncommon.rst
+doc/pyi2ncommon.cnfline.rst
+doc/pyi2ncommon.cnfvar.rst
+doc/modules.rst
 
 # PyDev
 .project

diff --git a/doc/about_docu.rst b/doc/about_docu.rst
index 0b9788d..898f0bc 100644 (file)
--- a/doc/about_docu.rst
+++ b/doc/about_docu.rst
@@ -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)
 
 

diff --git a/doc/modules.rst b/doc/modules.rst
deleted file mode 100644 (file)
index e9ff8ac..0000000
--- a/doc/modules.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-src
-===
-
-.. toctree::
-   :maxdepth: 4
-
-   src