Close

More and better Docs

A project log for Boxes.py

Cut out boxes and other stuff with a laser cutter

Florian FestiFlorian Festi 03/04/2019 at 21:550 Comments

I held a workshop at my local hacker space on how to write your own generators. As a side effect I restructured and extended the (API) docs and one participant updated the installation instructions. So now there are several new topics covered:

The API docs have now more of an top down approach. This makes it easier to understand the concepts and where to start. Also the previously broken module index is fixed and all the methods are referenced in the index.

There are still a lot of places the docs can be improved but I am trying to stop myself here. Overall it is probably better to crank out a few new features than loosing myself in the documentation. I guess most people are happy not needing to read docs and being able to generate a new box with the press of a single button.

Discussions