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

Documentation v1.0 #34

Open

4 of 9 tasks

Tracked by

Ylannl opened this issue Aug 8, 2024 · 0 comments

Open

4 of 9 tasks

Tracked by

Documentation v1.0 #34

Ylannl opened this issue Aug 8, 2024 · 0 comments

Milestone

Member

Ylannl commented Aug 8, 2024 •

edited

Loading

Installation/building
reconstruction function API's C++/Python binding
- API function reference (doxygen for C++)
- Tutorial (similar to GDAL/OGR tutorials)
roofer application
- Usage
- document configuration file and it's parameters
- Tutorial
Make CLI/configuration options self documenting (so that no manual edits to docs are needed if options are added/changed)

Could use doxygen + breathe + sphynx with furo theme

Ylannl mentioned this issue

Roofer v1.0 overview #1

Open

37 tasks

Ylannl added this to the v1.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment