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 #7

Closed
The-EDev opened this issue Oct 8, 2020 · 3 comments
Closed

Documentation #7

The-EDev opened this issue Oct 8, 2020 · 3 comments
Labels
task Non code related issue

Comments

@The-EDev
Copy link
Member

The-EDev commented Oct 8, 2020

in response to ipkn/crow#45, ipkn/crow#180, ipkn/crow#288.

We could either use the wiki and just explain things or set something like doxygen up.

either way some explanation as to how every part works and some form of API reference is needed.
@mrozigor
Copy link
Member

mrozigor commented Oct 8, 2020

I think that properly maintained doxygen will be ok. I'll try to find how to connect it with github, to automatically generate documentation here.

@mrozigor mrozigor added the task Non code related issue label Oct 8, 2020
@The-EDev
Copy link
Member Author

The-EDev commented Oct 9, 2020

this might be helpful.

@mrozigor
Copy link
Member

mrozigor commented Oct 9, 2020

I've found the same one yesterday :D

@The-EDev The-EDev mentioned this issue Oct 11, 2020
Closed
mrozigor added a commit that referenced this issue Oct 14, 2020
@mrozigor
#7 Automatically build documentation with Travis and Doxygen.
8f541d8
mrozigor added a commit that referenced this issue Oct 14, 2020
@mrozigor
#7 Change Doxyfile - it should generate standard html files by default.
1134f89
mrozigor added a commit that referenced this issue Oct 14, 2020
@mrozigor
#7 Redirect to documentation page.
9c09945
mrozigor added a commit that referenced this issue Oct 14, 2020
@mrozigor
#7 Generate docs only for one from all builds.
d174464
mrozigor added a commit that referenced this issue Oct 14, 2020
@mrozigor
#7 Change input directory for doxygen.
bd2affa
mrozigor added a commit that referenced this issue Oct 14, 2020
@mrozigor
#7 Change input directory for doxygen.
3cff9b1
mrozigor added a commit that referenced this issue Oct 14, 2020
@mrozigor
#7 Redirect to documentation page.
736d43e
mrozigor added a commit that referenced this issue Oct 14, 2020
@mrozigor
#7 Don't delete index.html when generating docs.
58bc717
mrozigor added a commit that referenced this issue Oct 14, 2020
@mrozigor
#7 Change redirect URL.
bc4e203
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
task Non code related issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mrozigor @The-EDev