Commit Graph

84 Commits

Author SHA1 Message Date
SuksAE 1bb4b8c0c3
Added pear shaped mounting hole drawing function (#392)
and add them to BinTray and TrafficLight
Add labels to the parts of these generators
Add doc strings to all hole types
2022-05-15 07:55:53 +02:00
suks.ae 3d7986f130 updated list of used edge characters in documentation
added reserved chars for generator use
changed generator template to reserved char
2022-04-19 21:57:58 +02:00
Florian Festi a7063011b5 Add inner_corner default setting
to allow removing the loops in inner corners

Related: #294
2022-03-20 19:04:27 +01:00
Florian Festi a364f603a8 Add extra_length to Finger Joint Settings
to allow extending the finger joints so burn marks can be ground off.

Thanks to all who have been pushing for this feature!

Resolves: #270
2022-01-16 15:18:11 +01:00
Stéphane MOR 64448d7902 cask is no longer a brew command 2022-01-07 09:44:44 +01:00
Florian Festi f18462585b User manual: More information about parameters
to be linked from the generator UI
2022-01-03 13:27:41 +01:00
Florian Festi 515c1a5149 FAQ: fix typo 2021-09-03 13:59:11 +02:00
Florian Festi 4449c2c2cd lxml is no longer used
Remove from requirements and installation docs

Related: #241
2021-06-07 05:08:47 +02:00
jens persson 9a46882c8f Add color selection to all holes
All methods that uses the holeCol decorator now take a parameter color.
Added semantic symbols for colors.
2021-06-03 21:40:11 +02:00
Florian Festi b344229c95 Add metadata to PostScript output
as title, creator and further comments.
Unfortunately pstoedit does drop these when converting to other
formats. A pity.
2021-05-29 10:55:36 +02:00
Mateusz Konieczny 3153e757b1 fix typo 2021-05-23 19:28:45 +02:00
Florian Festi 85de24b467 I add images to README
As README.rst is included from main dir add a symlink so links to the
images work for both locations.

No longer show information about the documentation in the documentation
itself.

Resolves: #292
2021-05-23 15:02:09 +02:00
Florian Festi dba67fce41 Fix link to Burn correction page 2021-05-23 11:15:59 +02:00
Florian Festi 3ece5843d0 Add Frequently Asked Questions 2021-05-23 11:00:31 +02:00
Henning Pridöhl 01f156d4a3 Fix Boxes.saved_context example in Navigation documentation
The code example for Boxes.saved_context() uses a with statement
that does not properly call the self.saved_context method (misses
call parenthesis).
2021-05-09 20:47:11 +02:00
Florian Festi 84e0fcd3df Add new burn correction to the documentation
Include picture of new over cuts
2021-04-25 19:13:05 +02:00
Florian Festi cf052f408b No longer mention cairo in the docs
Especially the installation docs
2020-05-18 22:30:28 +02:00
Ben Christenson 842769b69d added missing instructions for install cairo on mac 2020-02-23 16:08:56 +01:00
Ben Christenson bc2d16fb16 spelling nits in docs 2020-02-23 16:07:42 +01:00
Georges Khaznadar 715a2aca0b added man pages 2019-11-01 11:35:52 +01:00
Florian Festi b0b35d6084 Mention BurnTest in docs and in the burn parameter description 2019-10-19 12:29:56 +02:00
Florian Festi ecbb159c90 Drop Python 2 compatibility from the install docs 2019-09-06 19:23:58 +02:00
Florian Festi 0e41659ed8 Mention Sphinx dependency for building the docs 2019-03-06 23:55:07 +01:00
Florian Festi 4252cd22bc Fix formating in install doc 2019-03-06 19:09:15 +01:00
WU 522d2c4aa9 inkscape install documentation simplified 2019-03-06 18:58:09 +01:00
Martin Müller 6231c89f0d Fix typos and improve readability of commands 2019-02-28 08:03:08 +01:00
Martin Müller e2090e9999 Add workaround for Inkscape error on macOS 2019-02-28 07:56:25 +01:00
Martin Müller 10ad21d186 Add installation instructions for macOS 2019-02-28 07:56:25 +01:00
Martin Müller 2335395f20 Add images and details for Windows install guide 2019-02-26 21:35:47 +01:00
Florian Festi 9c6c54c2e2 API Docs: fix typo 2019-02-26 11:00:15 +01:00
Martin Müller 9135486d16 Add installation guide for Windows (fixes #83) 2019-02-26 09:44:46 +01:00
Martin Müller 0ba4281d91 Fix link in installation guide and minor typos 2019-02-26 00:03:01 +01:00
Florian Festi 981844285f API Docs: Fill navigation page 2019-02-24 15:56:54 +01:00
Florian Festi 1801cfd0cc API Docs: Add section about tabs 2019-02-24 13:14:21 +01:00
Florian Festi 0ede38a7da API docs: Add page on burn correction 2019-02-24 12:10:57 +01:00
Florian Festi b6f5f1e48f Use Python 2 to work on the Travis CI which builds the docs 2019-02-20 21:51:07 +01:00
Florian Festi b051f4d0f1 Improve README.rst 2019-02-20 21:43:16 +01:00
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