Minor improvments to the docs
This commit is contained in:
parent
e3ba617f22
commit
c59c0c287d
|
@ -62,7 +62,7 @@ Boxes.py. Here are some guidelines that make it easier to get them added:
|
|||
|
||||
* Start with a copy of another generator or *boxes/generators/_template.py*
|
||||
* Commit changes to the library in separate patches
|
||||
* Use arguments with sane defaults instead of hard coding measurements
|
||||
* Use parameters with sane defaults instead of hard coding dimmensions
|
||||
* Simple generators can end up as one single commit
|
||||
* For more complicated generators there can be multiple patches -
|
||||
each adding another feature
|
||||
|
@ -77,9 +77,11 @@ documentation feel free to submit a pull request or open a ticket
|
|||
pointing out what should be changed or even suggesting a better text.
|
||||
|
||||
To get the docs updated the docs need to be build with *make html* in
|
||||
*documentation/src* and then the files need ot be updated in the *gh-pages*
|
||||
branch. That's a bit tricky. Feel free to not even bother with this
|
||||
and just submit the changes to the sources or just open a ticket.
|
||||
*documentation/src*. This places the compliled documentation in
|
||||
*documentation/build/html*.
|
||||
|
||||
The online documentation gets build and updated automatically by the Travis CI
|
||||
as soon as the changes makes it into the GitHub master branch.
|
||||
|
||||
Improving the User Interface
|
||||
----------------------------
|
||||
|
|
|
@ -86,9 +86,8 @@ format
|
|||
......
|
||||
|
||||
Boxes.py is able to create multiple formats. For most of them it
|
||||
requires ``ps2edit``. Unfortunately it is currently not available on
|
||||
the server running the public web instance. Without it only ``SVG``
|
||||
and ``postscript`` (ps) is supported. With ``ps2edit`` you can also
|
||||
requires ``ps2edit``. Without ``ps2edit`` only ``SVG``
|
||||
and ``postscript`` (ps) is supported. Otherwise you can also
|
||||
select
|
||||
|
||||
* ai
|
||||
|
@ -97,8 +96,8 @@ select
|
|||
* pdf
|
||||
* plt
|
||||
|
||||
Other formats supported by ``ps2edit`` can be easily added. Please
|
||||
open a ticket if you need one.
|
||||
Other formats supported by ``ps2edit`` can be added easily. Please
|
||||
open a ticket on GitHub if you need one.
|
||||
|
||||
tabs
|
||||
....
|
||||
|
@ -106,7 +105,7 @@ tabs
|
|||
Tabs are small bridges between the parts and surrounding material that
|
||||
keep the part from falling out. In theory their width should be
|
||||
affected by the burn parameter. But it is more practical to have both
|
||||
be separate so you can tune them separately. Most parts and generators
|
||||
independent so you can tune them separately. Most parts and generators
|
||||
support this features but there may be some that don't.
|
||||
|
||||
For plywood values of 0.2 to 0.3mm still allow getting the parts out
|
||||
|
|
Loading…
Reference in New Issue