Skip to content

Commit 97e7064

Browse files
committed
Write docstrings derived from OpenSCAD manual
This change adds docstrings which are suitable for sphinx autodoc generation. The OpenSCAD User Manual is licensed under the Creative Commons Attribution-ShareAlike License, and my research suggests that it is safe to mix this with LGPL code. These docs can be generated with tox -edocs It would be very useful now for these docs to be hosted on https://readthedocs.org/
1 parent 6f09dd0 commit 97e7064

File tree

3 files changed

+319
-11
lines changed

3 files changed

+319
-11
lines changed

Diff for: Doc/index.rst

+5-2
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,17 @@ Contents:
1313

1414
.. include:: ../README.rst
1515

16+
Library Reference
17+
=================
18+
19+
.. automodule:: solid.solidpython
20+
:members:
1621
.. automodule:: solid
1722
:members:
1823
.. automodule:: solid.screw_thread
1924
:members:
2025
.. automodule:: solid.utils
2126
:members:
22-
.. automodule:: solid.solidpython
23-
:members:
2427

2528

2629
Indices and tables

Diff for: README.rst

+5
Original file line numberDiff line numberDiff line change
@@ -421,3 +421,8 @@ General Public License for more details.
421421

422422
`Full text of the
423423
license <http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt>`__.
424+
425+
Some class docstrings are derived from the `OpenSCAD User Manual
426+
<https://en.wikibooks.org/wiki/OpenSCAD_User_Manual>`__, so
427+
are available under the `Creative Commons Attribution-ShareAlike License
428+
<https://creativecommons.org/licenses/by-sa/3.0/>`__.

0 commit comments

Comments
 (0)