Profouzors
/
boxespy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
boxespy/documentation/src/api_existing_parts.rst

28 lines
847 B
ReStructuredText
Raw Normal View History

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-08 22:56:19 +01:00
Existing Parts
--------------
A couple of commands can create whole parts like walls. Typically the
spelling nits in docs
2020-02-23 13:57:39 +01:00
sizes given are the inner dimension not including additional space
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-08 22:56:19 +01:00
needed for burn compensation or joints.
Currently there are the following parts:
.. automethod:: boxes.Boxes.rectangularWall
.. automethod:: boxes.Boxes.flangedWall
.. automethod:: boxes.Boxes.rectangularTriangle
.. automethod:: boxes.Boxes.regularPolygonWall
Add polygonWall to Existing Parts doc
2022-12-04 00:29:04 +01:00
.. automethod:: boxes.Boxes.polygonWall
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-08 22:56:19 +01:00
.. automethod:: boxes.Boxes.roundedPlate
.. automethod:: boxes.Boxes.surroundingWall
Parts Class
...........
Fix typos
2022-12-28 17:03:26 +01:00
More parts are available in a separate class. An instance is available as
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-08 22:56:19 +01:00
**Boxes.parts**
.. automethod:: boxes.parts.Parts.disc
.. automethod:: boxes.parts.Parts.waivyKnob
.. automethod:: boxes.parts.Parts.concaveKnob
.. automethod:: boxes.parts.Parts.ringSegment