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

Generate API documentation and host #68

Open
mr-smidge opened this issue Jan 28, 2022 · 1 comment
Open

Generate API documentation and host #68

mr-smidge opened this issue Jan 28, 2022 · 1 comment
Labels
build Relating to the build

Comments

@mr-smidge
Copy link
Contributor

Overview

There have been at least half-reasonable efforts to document the public-facing elements of the codebase. There is also a long-forgotten Doxyfile.in in the repository root.

It should be possible to generate documentation using Doxygen (via either the meson or CMake build tools) and host this for users to see, perhaps via GitHub Pages.

Acceptance Criteria

  • It must be possible for the build system to generate documentation via Doxygen.
  • Generated documentation should be hosted somewhere for users to see.
@mr-smidge mr-smidge added the build Relating to the build label Jan 28, 2022
@mr-smidge
Copy link
Contributor Author

Also consider standardese as an alternative to Doxygen: https://github.com/standardese/standardese

@mr-smidge mr-smidge changed the title Generate doxygen documentation and host Generate API documentation and host Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Relating to the build
Projects
None yet
Development

No branches or pull requests

1 participant