Skip to content

Commit

Permalink
Add brief descriptions to tables
Browse files Browse the repository at this point in the history
  • Loading branch information
josephburkhart committed Feb 6, 2025
1 parent a8466fb commit 6d9af69
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/source/table-archimedean.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Archimedean Solids
===================

This table lists the 13 Archimedean Solids. They can be instantiated in two ways:

- :code:`families.ArchimedeanFamily.get_shape(\<name\>)`
- :code:`families.DOI_SHAPE_REPOSITORIES["10.1126/science.1220869"][0].get_shape(\<id\>)`

For implementation details see :py:class:`~coxeter.families.ArchimedeanFamily` and :py:data:`~coxeter.families.DOI_SHAPE_REPOSITORIES`.

.. csv-table::
:file: _data/science.1220869.archimedean.csv
:header-rows: 1
7 changes: 7 additions & 0 deletions doc/source/table-catalan.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Catalan Solids
===================

This table lists the 13 Catalan Solids. They can be instantiated in two ways:

- :code:`families.CatalanFamily.get_shape(\<name\>)`
- :code:`families.DOI_SHAPE_REPOSITORIES["10.1126/science.1220869"][0].get_shape(\<id\>)`

For implementation details see :py:class:`~coxeter.families.CatalanFamily` and :py:data:`~coxeter.families.DOI_SHAPE_REPOSITORIES`.

.. csv-table::
:file: _data/science.1220869.catalan.csv
:header-rows: 1
7 changes: 7 additions & 0 deletions doc/source/table-johnson.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Johnson Solids
===================

This table lists the 92 Johnson Solids. They can be instantiated in two ways:

- :code:`families.JohnsonFamily.get_shape(\<name\>)`
- :code:`families.DOI_SHAPE_REPOSITORIES["10.1126/science.1220869"][0].get_shape(\<id\>)`

For implementation details see :py:class:`~coxeter.families.JohnsonFamily` and :py:data:`~coxeter.families.DOI_SHAPE_REPOSITORIES`.

.. csv-table::
:file: _data/science.1220869.johnson.csv
:header-rows: 1
4 changes: 4 additions & 0 deletions doc/source/table-other.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Other Polyhedra
===================

This table lists 22 other useful polyhedra included in :cite:`Damasceno2012a`. They can be instantiated using :code:`families.DOI_SHAPE_REPOSITORIES["10.1126/science.1220869"][0].get_shape(\<id\>)`.

For implementation details see :py:data:`~coxeter.families.DOI_SHAPE_REPOSITORIES`.

.. csv-table::
:file: _data/science.1220869.other.csv
:header-rows: 1
7 changes: 7 additions & 0 deletions doc/source/table-platonic.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Platonic Solids
===================

This table lists the 5 Platonic Solids. They can be instantiated in two ways:

- :code:`families.PlatonicFamily.get_shape(\<name\>)`
- :code:`families.DOI_SHAPE_REPOSITORIES["10.1126/science.1220869"][0].get_shape(\<id\>)`

For implementation details see :py:class:`~coxeter.families.PlatonicFamily` and :py:data:`~coxeter.families.DOI_SHAPE_REPOSITORIES`.

.. csv-table::
:file: _data/science.1220869.platonic.csv
:header-rows: 1
4 changes: 4 additions & 0 deletions doc/source/table-prism-antiprism.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Prisms and Antiprisms
=====================

This table lists 16 members of the Prism-Antiprism family. They can be instantiated using :code:`families.PrismAntiprismFamily.get_shape(\<name\>)`, but most of them can also be found among the :doc:`Other Polyhedra<table-other>` from :cite:`Damasceno2012a`.

For implementation details see :py:class:`~coxeter.families.PrismAntiprismFamily`.

.. csv-table::
:file: _data/prismantiprism.csv
:header-rows: 1
4 changes: 4 additions & 0 deletions doc/source/table-pyramid-dipyramid.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Pyramids and Dipyramids
===================

This table lists 6 members of the Pyramid-Dipyramid family. They can be instantiated using :code:`families.PyramidDipyramidFamily.get_shape(\<name\>)`, but most of them can also be found among the :doc:`Johnson Solids<table-other>` from :cite:`Damasceno2012a`.

For implementation details see :py:class:`~coxeter.families.PyramidDipyramidFamily`.

.. csv-table::
:file: _data/pyramiddipyramid.csv
:header-rows: 1

0 comments on commit 6d9af69

Please sign in to comment.