anstmichaels / emopt

A suite of tools for optimizing the shape and topology of electromagnetic structures.
BSD 3-Clause "New" or "Revised" License
100 stars 41 forks source link

Lack of API Reference in Documentation #27

Open FaresBadrCA opened 6 months ago

FaresBadrCA commented 6 months ago

Problem

The API reference is missing from the documentation. There is a link to a module index on Read the Docs, but that index was not built. https://emopt.readthedocs.io/en/latest/py-modindex.html

While the provided tutorials are very helpful, a more comprehensive API reference is required.

Solution

Ensure that module documentation is included in the sphinx build makefile. sphinx-apidoc -o . $(SPHINXPROJ)