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.

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

doc: Generate Sphinx documentation for API #12

Merged
merged 10 commits into from
Jan 25, 2024
Merged

doc: Generate Sphinx documentation for API #12

merged 10 commits into from
Jan 25, 2024

Conversation

gliga
Copy link
Member

@gliga gliga commented Jan 25, 2024

This PR replaces legacy documentation generation (using doxygen) with generation into Sphinx format.

The following is decided in this PR:

  • Generate one file per module/file
  • Include documentation for each module (brief)
  • Include all functions (that do not start with _)
  • Exclude _test.sh files
  • Include brief description for functions

@gliga gliga changed the title Gligoric/api doc: Generate Sphinx documentation for API Jan 25, 2024
@gliga gliga merged commit d7b50b3 into main Jan 25, 2024
12 checks passed
@gliga gliga deleted the gligoric/api branch January 26, 2024 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant