Profouzors
/
boxespy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor improvments to the docs

This commit is contained in:
Florian Festi 2019-02-12 18:42:01 +01:00
parent e3ba617f22
commit c59c0c287d
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.rst
View File

@ -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* * Start with a copy of another generator or *boxes/generators/_template.py*
* Commit changes to the library in separate patches * 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 * Simple generators can end up as one single commit
* For more complicated generators there can be multiple patches - * For more complicated generators there can be multiple patches -
each adding another feature 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. 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 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* *documentation/src*. This places the compliled documentation in
branch. That's a bit tricky. Feel free to not even bother with this *documentation/build/html*.
and just submit the changes to the sources or just open a ticket.
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 Improving the User Interface
---------------------------- ----------------------------

11
documentation/src/usermanual.rst
View File

@ -86,9 +86,8 @@ format
...... ......
Boxes.py is able to create multiple formats. For most of them it Boxes.py is able to create multiple formats. For most of them it
requires ``ps2edit``. Unfortunately it is currently not available on requires ``ps2edit``. Without ``ps2edit`` only ``SVG``
the server running the public web instance. Without it only ``SVG`` and ``postscript`` (ps) is supported. Otherwise you can also
and ``postscript`` (ps) is supported. With ``ps2edit`` you can also
select select
* ai * ai
@ -97,8 +96,8 @@ select
* pdf * pdf
* plt * plt
Other formats supported by ``ps2edit`` can be easily added. Please Other formats supported by ``ps2edit`` can be added easily. Please
open a ticket if you need one. open a ticket on GitHub if you need one.
tabs tabs
.... ....
@ -106,7 +105,7 @@ tabs
Tabs are small bridges between the parts and surrounding material that Tabs are small bridges between the parts and surrounding material that
keep the part from falling out. In theory their width should be 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 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. 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 For plywood values of 0.2 to 0.3mm still allow getting the parts out