update docs

fstwn · Aug 14, 2020 · 03451f6 · 03451f6
1 parent c862710
commit 03451f6
Show file tree

Hide file tree

Showing 19 changed files with 106 additions and 74 deletions.
diff --git a/CockatooManual.pdf b/CockatooManual.pdf
diff --git a/docs/README.html b/docs/README.html
@@ -206,6 +206,7 @@
 
   <div class="section" id="cockatoo">
 <h1>COCKATOO<a class="headerlink" href="#cockatoo" title="Permalink to this headline">¶</a></h1>
+<p><img alt="Automatic knitting pattern generation using Cockatoo" src="_images/readme_img_01.jpg" /></p>
 <ul class="simple">
 <li><p>Cockatoo is a prototypical open-source software toolkit for
 generating (3d-)knitting patterns from NURBS surface and mesh
@@ -320,7 +321,7 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <ul class="simple">
 <li><p>Go to <a class="reference external" href="https://github.com/fstwn/cockatoo/releases">releases</a> and
 download the newest release</p></li>
-<li><p>Unzip the downloaded archive. You should get two folders: <code class="docutils literal notranslate"><span class="pre">modules</span></code>
+<li><p>Unzip the downloaded archive. You should get the folders: <code class="docutils literal notranslate"><span class="pre">modules</span></code>
 and <code class="docutils literal notranslate"><span class="pre">Cockatoo</span></code>.</p></li>
 </ul>
 </div>

diff --git a/docs/_images/readme_img_01.jpg b/docs/_images/readme_img_01.jpg
diff --git a/docs/_sources/README.rst.txt b/docs/_sources/README.rst.txt
@@ -1,6 +1,8 @@
 COCKATOO
 ========
 
+|Automatic knitting pattern generation using Cockatoo|
+
 -  Cockatoo is a prototypical open-source software toolkit for
    generating (3d-)knitting patterns from NURBS surface and mesh
    geometry.
@@ -126,7 +128,7 @@ Installation
 
 -  Go to `releases <https://github.com/fstwn/cockatoo/releases>`__ and
    download the newest release
--  Unzip the downloaded archive. You should get two folders: ``modules``
+-  Unzip the downloaded archive. You should get the folders: ``modules``
    and ``Cockatoo``.
 
 .. _2.-install-python-modules:
@@ -306,3 +308,6 @@ Misc
    Ruttens <https://ieatbugsforbreakfast.wordpress.com/>`__ delightful
    sense of humor which has changed many of my darker days for the
    better.
+
+.. |Automatic knitting pattern generation using Cockatoo| image:: images/readme_img_01.jpg
+
diff --git a/docsource/README.rst b/docsource/README.rst
@@ -1,6 +1,8 @@
 COCKATOO
 ========
 
+|Automatic knitting pattern generation using Cockatoo|
+
 -  Cockatoo is a prototypical open-source software toolkit for
    generating (3d-)knitting patterns from NURBS surface and mesh
    geometry.
@@ -126,7 +128,7 @@ Installation
 
 -  Go to `releases <https://github.com/fstwn/cockatoo/releases>`__ and
    download the newest release
--  Unzip the downloaded archive. You should get two folders: ``modules``
+-  Unzip the downloaded archive. You should get the folders: ``modules``
    and ``Cockatoo``.
 
 .. _2.-install-python-modules:
@@ -306,3 +308,6 @@ Misc
    Ruttens <https://ieatbugsforbreakfast.wordpress.com/>`__ delightful
    sense of humor which has changed many of my darker days for the
    better.
+
+.. |Automatic knitting pattern generation using Cockatoo| image:: images/readme_img_01.jpg
+
diff --git a/docsource/_build/doctrees/README.doctree b/docsource/_build/doctrees/README.doctree
diff --git a/docsource/_build/doctrees/environment.pickle b/docsource/_build/doctrees/environment.pickle
diff --git a/docsource/_build/html/README.html b/docsource/_build/html/README.html
@@ -206,6 +206,7 @@
 
   <div class="section" id="cockatoo">
 <h1>COCKATOO<a class="headerlink" href="#cockatoo" title="Permalink to this headline">¶</a></h1>
+<p><img alt="Automatic knitting pattern generation using Cockatoo" src="_images/readme_img_01.jpg" /></p>
 <ul class="simple">
 <li><p>Cockatoo is a prototypical open-source software toolkit for
 generating (3d-)knitting patterns from NURBS surface and mesh
@@ -320,7 +321,7 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <ul class="simple">
 <li><p>Go to <a class="reference external" href="https://github.com/fstwn/cockatoo/releases">releases</a> and
 download the newest release</p></li>
-<li><p>Unzip the downloaded archive. You should get two folders: <code class="docutils literal notranslate"><span class="pre">modules</span></code>
+<li><p>Unzip the downloaded archive. You should get the folders: <code class="docutils literal notranslate"><span class="pre">modules</span></code>
 and <code class="docutils literal notranslate"><span class="pre">Cockatoo</span></code>.</p></li>
 </ul>
 </div>

diff --git a/docsource/_build/html/_images/readme_img_01.jpg b/docsource/_build/html/_images/readme_img_01.jpg
diff --git a/docsource/_build/html/_sources/README.rst.txt b/docsource/_build/html/_sources/README.rst.txt
@@ -1,6 +1,8 @@
 COCKATOO
 ========
 
+|Automatic knitting pattern generation using Cockatoo|
+
 -  Cockatoo is a prototypical open-source software toolkit for
    generating (3d-)knitting patterns from NURBS surface and mesh
    geometry.
@@ -126,7 +128,7 @@ Installation
 
 -  Go to `releases <https://github.com/fstwn/cockatoo/releases>`__ and
    download the newest release
--  Unzip the downloaded archive. You should get two folders: ``modules``
+-  Unzip the downloaded archive. You should get the folders: ``modules``
    and ``Cockatoo``.
 
 .. _2.-install-python-modules:
@@ -306,3 +308,6 @@ Misc
    Ruttens <https://ieatbugsforbreakfast.wordpress.com/>`__ delightful
    sense of humor which has changed many of my darker days for the
    better.
+
+.. |Automatic knitting pattern generation using Cockatoo| image:: images/readme_img_01.jpg
+
diff --git a/docsource/_build/latex/cockatoo.aux b/docsource/_build/latex/cockatoo.aux
@@ -27,10 +27,10 @@
 \@writefile{toc}{\contentsline {section}{\numberline {1.1}Purpose \& Origins}{1}{section.1.1}\protected@file@percent }
 \newlabel{README:purpose-origins}{{1.1}{1}{Purpose \& Origins}{section.1.1}{}}
 \newlabel{README:id1}{{1.1}{1}{Purpose \& Origins}{section.1.1}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {1.2}Software Structure}{1}{section.1.2}\protected@file@percent }
-\newlabel{README:software-structure}{{1.2}{1}{Software Structure}{section.1.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {1.2.1}Python Module}{1}{subsection.1.2.1}\protected@file@percent }
-\newlabel{README:python-module}{{1.2.1}{1}{Python Module}{subsection.1.2.1}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.2}Software Structure}{2}{section.1.2}\protected@file@percent }
+\newlabel{README:software-structure}{{1.2}{2}{Software Structure}{section.1.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.2.1}Python Module}{2}{subsection.1.2.1}\protected@file@percent }
+\newlabel{README:python-module}{{1.2.1}{2}{Python Module}{subsection.1.2.1}{}}
 \@writefile{toc}{\contentsline {subsection}{\numberline {1.2.2}Rhino Integration}{2}{subsection.1.2.2}\protected@file@percent }
 \newlabel{README:rhino-integration}{{1.2.2}{2}{Rhino Integration}{subsection.1.2.2}{}}
 \@writefile{toc}{\contentsline {subsection}{\numberline {1.2.3}Grasshopper Components}{2}{subsection.1.2.3}\protected@file@percent }
@@ -43,13 +43,13 @@
 \newlabel{README:development-environment}{{1.3.1}{2}{Development Environment}{subsection.1.3.1}{}}
 \@writefile{toc}{\contentsline {subsection}{\numberline {1.3.2}Graph Library}{2}{subsection.1.3.2}\protected@file@percent }
 \newlabel{README:graph-library}{{1.3.2}{2}{Graph Library}{subsection.1.3.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.3}Partial Dependencies}{2}{subsection.1.3.3}\protected@file@percent }
-\newlabel{README:partial-dependencies}{{1.3.3}{2}{Partial Dependencies}{subsection.1.3.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {1.4}Installation}{2}{section.1.4}\protected@file@percent }
-\newlabel{README:installation}{{1.4}{2}{Installation}{section.1.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {1.4.1}1. Download release files}{2}{subsection.1.4.1}\protected@file@percent }
-\newlabel{README:download-release-files}{{1.4.1}{2}{1. Download release files}{subsection.1.4.1}{}}
-\newlabel{README:id2}{{1.4.1}{2}{1. Download release files}{subsection.1.4.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.3}Partial Dependencies}{3}{subsection.1.3.3}\protected@file@percent }
+\newlabel{README:partial-dependencies}{{1.3.3}{3}{Partial Dependencies}{subsection.1.3.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.4}Installation}{3}{section.1.4}\protected@file@percent }
+\newlabel{README:installation}{{1.4}{3}{Installation}{section.1.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.4.1}1. Download release files}{3}{subsection.1.4.1}\protected@file@percent }
+\newlabel{README:download-release-files}{{1.4.1}{3}{1. Download release files}{subsection.1.4.1}{}}
+\newlabel{README:id2}{{1.4.1}{3}{1. Download release files}{subsection.1.4.1}{}}
 \@writefile{toc}{\contentsline {subsection}{\numberline {1.4.2}2. Install python modules}{3}{subsection.1.4.2}\protected@file@percent }
 \newlabel{README:install-python-modules}{{1.4.2}{3}{2. Install python modules}{subsection.1.4.2}{}}
 \newlabel{README:id3}{{1.4.2}{3}{2. Install python modules}{subsection.1.4.2}{}}
@@ -59,12 +59,12 @@
 \@writefile{toc}{\contentsline {subsection}{\numberline {1.4.4}4. Unblock the new UserObjects!}{3}{subsection.1.4.4}\protected@file@percent }
 \newlabel{README:unblock-the-new-userobjects}{{1.4.4}{3}{4. Unblock the new UserObjects!}{subsection.1.4.4}{}}
 \newlabel{README:id5}{{1.4.4}{3}{4. Unblock the new UserObjects!}{subsection.1.4.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {1.4.5}5. Restart Rhino \& Grasshopper}{3}{subsection.1.4.5}\protected@file@percent }
-\newlabel{README:restart-rhino-grasshopper}{{1.4.5}{3}{5. Restart Rhino \& Grasshopper}{subsection.1.4.5}{}}
-\newlabel{README:id6}{{1.4.5}{3}{5. Restart Rhino \& Grasshopper}{subsection.1.4.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {1.5}Examples \& Usage}{3}{section.1.5}\protected@file@percent }
-\newlabel{README:examples-usage}{{1.5}{3}{Examples \& Usage}{section.1.5}{}}
-\newlabel{README:id7}{{1.5}{3}{Examples \& Usage}{section.1.5}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {1.4.5}5. Restart Rhino \& Grasshopper}{4}{subsection.1.4.5}\protected@file@percent }
+\newlabel{README:restart-rhino-grasshopper}{{1.4.5}{4}{5. Restart Rhino \& Grasshopper}{subsection.1.4.5}{}}
+\newlabel{README:id6}{{1.4.5}{4}{5. Restart Rhino \& Grasshopper}{subsection.1.4.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.5}Examples \& Usage}{4}{section.1.5}\protected@file@percent }
+\newlabel{README:examples-usage}{{1.5}{4}{Examples \& Usage}{section.1.5}{}}
+\newlabel{README:id7}{{1.5}{4}{Examples \& Usage}{section.1.5}{}}
 \@writefile{toc}{\contentsline {section}{\numberline {1.6}Testing \& Contributing}{4}{section.1.6}\protected@file@percent }
 \newlabel{README:testing-contributing}{{1.6}{4}{Testing \& Contributing}{section.1.6}{}}
 \newlabel{README:id8}{{1.6}{4}{Testing \& Contributing}{section.1.6}{}}

diff --git a/docsource/_build/latex/cockatoo.fdb_latexmk b/docsource/_build/latex/cockatoo.fdb_latexmk
@@ -1,10 +1,10 @@
 # Fdb version 3
-["makeindex cockatoo.idx"] 1597324514 "cockatoo.idx" "cockatoo.ind" "cockatoo" 1597324517
-  "cockatoo.idx" 1597324517 15612 8fe15b9e170229d4ed891d4e73e853dc "pdflatex"
+["makeindex cockatoo.idx"] 1597407108 "cockatoo.idx" "cockatoo.ind" "cockatoo" 1597407114
+  "cockatoo.idx" 1597407114 15612 8fe15b9e170229d4ed891d4e73e853dc "pdflatex"
   (generated)
   "cockatoo.ind"
   "cockatoo.ilg"
-["pdflatex"] 1597324514 "cockatoo.tex" "cockatoo.pdf" "cockatoo" 1597324517
+["pdflatex"] 1597407111 "cockatoo.tex" "cockatoo.pdf" "cockatoo" 1597407114
   "C:/Users/EFESTWIN/AppData/Local/MiKTeX/2.9/miktex/data/le/pdftex/pdflatex.fmt" 1591558437 10022112 b5bb11747b2594655e7abbe8db7bda1a ""
   "C:/Users/EFESTWIN/AppData/Local/MiKTeX/2.9/pdftex/config/pdftex.map" 1591714872 82507 a9eef8696c92627b87e9975edea03b2a ""
   "C:/Users/EFESTWIN/AppData/Local/Programs/MiKTeX 2.9/fonts/enc/dvips/base/8r.enc" 1458477487 4993 80dc9bab7f31fb78a000ccfed0e27cab ""
@@ -164,22 +164,23 @@
   "C:/Users/EFESTWIN/AppData/Local/Programs/MiKTeX 2.9/tex/latex/varwidth/varwidth.sty" 1238469540 10894 d359a13923460b2a73d4312d613554c8 ""
   "C:/Users/EFESTWIN/AppData/Local/Programs/MiKTeX 2.9/tex/latex/wrapfig/wrapfig.sty" 1044406800 26220 3701aebf80ccdef248c0c20dd062fea9 ""
   "C:/Users/EFESTWIN/AppData/Local/Programs/MiKTeX 2.9/tex/latex/xcolor/xcolor.sty" 1463135581 57049 34128738f682d033422ca125f82e5d62 ""
-  "cockatoo.aux" 1597324517 20807 85ba1e610f80e078d7d4b3d38c64e4d6 "pdflatex"
-  "cockatoo.ind" 1597324514 10775 04fcc9e61b688a3316186cf2e3abe039 "makeindex cockatoo.idx"
-  "cockatoo.out" 1597324517 1959 125e82eb7dc9e51ebcae2f127efa7005 "pdflatex"
-  "cockatoo.tex" 1597324511 178013 01232d05a1ff4c8a952766b671fb7179 ""
-  "cockatoo.toc" 1597324517 3277 11ea41f9c20d8c79cd5a0bffb2796e43 "pdflatex"
+  "cockatoo.aux" 1597407114 20807 d4c877ac9673b6c5e5facde1829c0f7b "pdflatex"
+  "cockatoo.ind" 1597407108 10775 04fcc9e61b688a3316186cf2e3abe039 "makeindex cockatoo.idx"
+  "cockatoo.out" 1597407114 1959 125e82eb7dc9e51ebcae2f127efa7005 "pdflatex"
+  "cockatoo.tex" 1597407105 178060 ab7de6e1756c817d5c276342051cdce6 ""
+  "cockatoo.toc" 1597407114 3277 9b0acd934575125a896a55c59dcdf8e7 "pdflatex"
   "footnotehyper-sphinx.sty" 1587307844 8888 1bbd7bdeae8c8bed1d10d551bddb1cc9 ""
   "latex.jpg" 1597087549 877795 70132ec01c979f41cd1496958163bfdf ""
+  "readme_img_01.jpg" 1597405829 418649 99131e6e876759b66067d0d4bdd10157 ""
   "sphinx.sty" 1587307844 82020 a38700b8aa22dfd94a8a5b905e69be73 ""
-  "sphinxhighlight.sty" 1597324510 4526 709b60d4a1b474be7d690756ea39f83e ""
+  "sphinxhighlight.sty" 1597407104 4526 709b60d4a1b474be7d690756ea39f83e ""
   "sphinxmanual.cls" 1587307844 4236 124cd90deb92742b5d3922bfc2cd70c0 ""
-  "sphinxmessages.sty" 1597324511 765 3f5fcd6cdd7964ed608767954a8ced6f ""
+  "sphinxmessages.sty" 1597407105 765 3f5fcd6cdd7964ed608767954a8ced6f ""
   "sphinxmulticell.sty" 1587307844 14606 0b6edc2b1a83546ed92026d1f6a311b5 ""
   (generated)
-  "cockatoo.toc"
-  "cockatoo.out"
+  "cockatoo.pdf"
   "cockatoo.idx"
-  "cockatoo.log"
+  "cockatoo.out"
   "cockatoo.aux"
-  "cockatoo.pdf"
+  "cockatoo.log"
+  "cockatoo.toc"
diff --git a/docsource/_build/latex/cockatoo.fls b/docsource/_build/latex/cockatoo.fls
@@ -265,15 +265,22 @@ INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\vf\adobe\times\p
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\times\ptmr8r.tfm
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\vf\adobe\helvetic\phvb8t.vf
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\helvetic\phvb8r.tfm
+INPUT readme_img_01.jpg
+INPUT .\readme_img_01.jpg
+INPUT .\readme_img_01.jpg
+INPUT .\readme_img_01.jpg
+INPUT .\readme_img_01.jpg
+INPUT readme_img_01.jpg
+INPUT .\readme_img_01.jpg
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\tex\latex\psnfss\ts1ptm.fd
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\tex\latex\psnfss\ts1ptm.fd
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\times\ptmr8c.tfm
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\times\ptmri8t.tfm
-INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\times\ptmr8t.tfm
-INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\helvetic\phvr8t.tfm
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\vf\adobe\times\ptmr8c.vf
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\vf\adobe\times\ptmri8t.vf
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\times\ptmri8r.tfm
+INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\times\ptmr8t.tfm
+INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\helvetic\phvr8t.tfm
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\vf\adobe\courier\pcrr8t.vf
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\courier\pcrr8r.tfm
 INPUT C:\Users\EFESTWIN\AppData\Local\Programs\MiKTeX 2.9\fonts\tfm\adobe\courier\pcrro8t.tfm