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

Documentation generation issues #2

Open
1 of 5 tasks
lhstrh opened this issue Oct 14, 2021 · 0 comments
Open
1 of 5 tasks

Documentation generation issues #2

lhstrh opened this issue Oct 14, 2021 · 0 comments
Labels
help wanted Extra attention is needed

Comments

@lhstrh
Copy link
Member

lhstrh commented Oct 14, 2021 •
edited
Loading

We have an automated documentation system based on Doxygen + Breathe + Sphinx, contributed by @arengarajan99.

There are still some missing features/issues. Here are tasks left to complete:

  • Ensure that extern functions with multiple implementations generate readable documentation
  • Ensure that the source code directory hierarchy is properly reflected in the docs
  • Create a Github Actions docs generation + deployment workflow
  • Describe how to generate documentation locally in README.md
  • Simplify Python module installation and update README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lhstrh