Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Lack of API Reference in Documentation #27

Open
FaresBadrCA opened this issue Apr 15, 2024 · 0 comments
Open

Lack of API Reference in Documentation #27

FaresBadrCA opened this issue Apr 15, 2024 · 0 comments

Comments

@FaresBadrCA
Copy link

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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@FaresBadrCA