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

Run doxygen and publish to gh-pages branch #118

Open
LegalizeAdulthood opened this issue Dec 18, 2017 · 4 comments
Open

Run doxygen and publish to gh-pages branch #118

LegalizeAdulthood opened this issue Dec 18, 2017 · 4 comments

Comments

@LegalizeAdulthood
Copy link
Contributor

One way to encourage use of Kvasir is to have documentation as readily accessible as possible.

The wiki seems a little stale and doesn't cover all the information you need.

There is a Doxyfile, but I haven't attempted to run doxygen to see what is produced. If this is the intended way to document the API, then we should regularly run doxygen and push the results to the github pages.

@odinthenerd
Copy link
Member

doxygen is a bit hard sometimes with heavily templated code. We have been using standardese on some other kvasir projects. lack of documentation is a real problem I agree.

@LegalizeAdulthood
Copy link
Contributor Author

Have you looked at doxypress? It uses Clang as the front end, so should have better luck at parsing modern C++.

@LegalizeAdulthood
Copy link
Contributor Author

I'm trying doxypress right now... it's been grinding for several hours, LOL. I think what I need to do is configure it to ignore the 770 MB of generated chip files.

@odinthenerd
Copy link
Member

odinthenerd commented Dec 24, 2017

yes, the sheer volume of generated files needs to change. I think I can generate conan packages for all the chips that just generate on the fly, then you only get the generated files relevant to exactly the chip you are using.

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

No branches or pull requests

2 participants