Commit Graph

97 Commits

Author SHA1 Message Date
Florian Festi 0a73e929ec Restructure API docs and generate module index
Automatically generate docs for generators.
Semiautomatically generate doc for all other modules.
This should create the - until now - missing module index
2019-02-20 21:18:35 +01:00
Florian Festi c59c0c287d Minor improvments to the docs 2019-02-12 18:42:01 +01:00
Florian Festi 57873f886c Change style used for docs 2019-02-07 17:44:12 +01:00
Florian Festi fb12098d1a Typo 2019-02-07 17:43:35 +01:00
Florian Festi d90b93a49d Remove now private method from docs 2019-02-07 17:43:14 +01:00
Rotzbua 21172a592f create travis build script for doc
Edited by Florian Festi
2018-11-04 13:37:52 +01:00
Florian Festi 05aa486c1c Rename to CONTRIBUTING.rst to make GitHub happy
Add missing file
2018-09-11 17:55:17 +02:00
Florian Festi ef30589f8f Convert CONTRIBUTE to rst and add to the Docs.
Let's see if GitHub is happy with this...
2018-09-11 17:44:27 +02:00
Florian Festi 57fbda35e0 Extend docs by adding User Docs and and Introduction to the API 2018-09-11 17:43:33 +02:00
Florian Festi f15fedd2e2 Docs: Add intro to Edges 2018-09-11 14:14:12 +02:00
Florian Festi 4bea8638c3 Docs: Add requirement for setuptools
Clearify Windows installation (a little bit)
2018-09-10 10:00:02 +02:00
Florian Festi c4bfe8e122 Update API docs
Add "new" parts, partsMatrix() and various holes
2018-08-23 23:42:51 +02:00
Florian Festi 4916118b8b Add markdown as requiremnt in the install docs 2018-08-15 12:08:31 +02:00
Florian Festi 9de1bc10e5 Fix typo 2017-05-04 21:41:18 +02:00
Florian Festi 6b8b5645c2 Add lxml as soft dependency in the install section of the docs 2017-03-10 23:00:42 +01:00
Florian Festi 2c721a98f1 Add install.rst, remove TODO.rst
Todos moved to GH as issues
Some description on installation and the Inkscape plugins
2017-02-26 13:47:06 +01:00
Florian Festi 1e67ee7035 Clean up todo list
Remove item resulting in Box4 and Box5 from todo list
Settings for flex got added
2017-02-13 23:18:08 +01:00
Florian Festi 23c2dd3b09 Update slides 2016-07-19 17:40:08 +02:00
Florian Festi fe9fb57a21 Add more stuff to todo list 2016-07-03 16:41:53 +02:00
Florian Festi 4a70c50ea9 Remove treasure chest lid from todo list 2016-07-01 10:16:04 +02:00
Florian Festi a7f0e97012 Add GrippingEdge
Still needs to replace Boxes.grip()
2016-06-30 14:25:29 +02:00
Florian Festi 60d465c83a Add edges for hinges 2016-06-30 10:32:41 +02:00
Florian Festi 3283279af6 Update slides for talk in Oldenburg 2016-05-30 21:59:19 +02:00
Florian Festi 4c9d68626b Adjust docs to new BaseEdge class 2016-05-21 18:15:21 +02:00
Florian Festi e3673df408 Fix surroundingWall to work with Edegs with non zero .(start|end)width()
Add Boxes.edgeCorner() to join to Edges with the proper width correction
and use it in rectangluarWall() and surroundingWall()
2016-04-26 11:54:37 +02:00
Florian Festi ff1dc830e3 traylayout: fix cuts in inner corners of the floor plate 2016-04-18 17:42:29 +02:00
Florian Festi 3c56abf047 traylayout: Use straight edges on walls with no floor underneeth
Still need to move it over to use E in stead of e
2016-04-17 18:08:09 +02:00
Florian Festi 0e5e344c46 Remove obsolete entries from TODO list 2016-04-09 20:54:23 +02:00
Florian Festi 5c20ecef12 Fix typos in docs 2016-04-09 20:54:05 +02:00
Florian Festi 15d2fbfeb9 Update documentation for fingerHolesAt() -> FingerHoles change 2016-04-09 16:36:13 +02:00
Florian Festi 223f078726 Add StackableEdge class 2016-04-09 15:44:27 +02:00
Florian Festi 6273c13188 Minor updates 2016-04-09 15:44:27 +02:00
Florian Festi 9fc558dfe9 Add helper file forgotten in last commit 2016-04-06 20:00:19 +02:00
Florian Festi 15395b494b Move README into sub page 2016-04-06 18:55:14 +02:00
Florian Festi 63866ca532 Move documentation files into src/ sub dir 2016-04-06 18:13:09 +02:00
Florian Festi fa0181311e Add to the documentation
Move content of API.txt into the docs
Rename TODO.txt and add it to the docs
2016-04-06 17:52:51 +02:00
Florian Festi bc106cdf62 Reformat TODO list 2016-04-03 12:58:17 +02:00
Florian Festi 18c50a53aa Add Sphinxs based documentation 2016-04-03 12:58:17 +02:00
Florian Festi 0399bafe1b Remove the Edges instances form the Boxes name space.
Move over all generators to use Boxes.edges.
2016-04-02 20:52:27 +02:00
Florian Festi d6fe98635e More updates to the presentation
Add explainantion to burn correction
2016-04-02 14:14:55 +02:00
Florian Festi 721e286508 Some more editing of the presentation 2016-03-31 23:10:32 +02:00
Florian Festi ab3d9ed740 First changes 2016-03-30 23:24:24 +02:00
Florian Festi ef7fcd76d8 Fix some typos 2016-03-30 22:15:58 +02:00
Florian Festi 9322467c7b Use stretch setting in surroundingWall() 2016-03-30 21:09:19 +02:00
Florian Festi 31a6af5116 Add script for geenrating examples
Regenerate examples with current code
2016-03-28 12:19:25 +02:00
Florian Festi 36c2218065 Move API docs out into own file 2016-03-26 15:59:44 +01:00
Florian Festi 4bc85b3be4 Make this a proper Python package using setuptools
Added setup.py and MANIFEST.in. MOved documentation into its own sub dir
2016-03-26 11:12:14 +01:00