more docs

Author: Yiannis Gatsoulis

.gitignore

@@ -58,6 +58,7 @@ target/
 .idea/
 
 *~
+.DS_Store
 
 # DOC
 qsr_lib/docs/_build/

docs/README.md

@@ -15,14 +15,15 @@ make html
 ```
 
 ## `qsrs.rst`
-`qsrs.rst` is generated from `qsrs.md` as writing tables in RsT is a pain. md files can be converted to rst ones using 
-`pandoc`. The actual command run from within the `docs/rsts/handwritten` folder is:
+The table in `qsrs.rst` is generated from `qsrs_table.md` as writing tables in RsT is a pain.
+md files can be converted to rst ones using  `pandoc`. 
+The actual command run from within the `docs/rsts/handwritten/qsrs` folder is:
 
 ```bash
-pandoc --from=markdown --to=rst --output=qsrs.rst qsrs.md
+pandoc --from=markdown --to=rst --output=qsrs_table.rst qsrs_table.md
 ```
 
 If pandoc converts "\`" to "\`\`" then do two string replacements:
 
 1. "\`\`" to "\`"
-2. "\` " to "\`   ", i.e 'backtilt+1 space' to 'backtilt+3 spaces'
+2. "\`  " to "\`     ", i.e 'backtilt+2 spaces' to 'backtilt+6 spaces'

docs/index.rst

@@ -19,7 +19,7 @@ Contents:
    rsts/handwritten/authors
    rsts/handwritten/install
    rsts/handwritten/usage
-   rsts/handwritten/qsrs
+   rsts/handwritten/qsrs/qsrs
    rsts/handwritten/for_developers
    rsts/api/modules
 

docs/rsts/api/qsrlib_qsrs.qsr_cone_direction_bounding_boxes_centroid_2d.rst renamed to docs/rsts/api/qsrlib_qsrs.qsr_cardinal_direction_bounding_boxes_centroid_2d.rst

@@ -1,5 +1,5 @@
 qsrlib_qsrs.qsr_cardinal_direction_bounding_boxes_centroid_2d module
-================================================================
+====================================================================
 
 .. automodule:: qsrlib_qsrs.qsr_cardinal_direction_bounding_boxes_centroid_2d
     :members: