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

adding documentation based on Sphinx and Doxygen #374

Merged
merged 49 commits into from Apr 11, 2019

Conversation

Projects
None yet
5 participants
@zanellia
Copy link
Member

zanellia commented Apr 2, 2019

Hi guys, @tmmsartor and I have worked on a new documentation based on Sphinx and Doxygen, which should help a bit new users to get into the acados C API. We have set up a Doxygen project that automatically extracts documentation from the code of acados_c and, through breathe makes it usable from a web page built with Sphinx. For the time being the output of Doxygen is not very descriptive because we all need to contribute to the documentation in the code, but it will be as we gradually add this contents. Moreover a Doxygen project for the full acados code base (acados_c + core) is available for developers/advanced users. The page is not online yet, but you can build it following the instructions created by @tmmsartor in the docs folder. Let us know what you think!

coming soon: fully documented C API and core file examples such that we can all easily contribute based on the given format.

zanellia and others added some commits Mar 28, 2019

Merge pull request #14 from tmmsartor/docu
docs: Update/create sphinx user docs
Merge pull request #15 from tmmsartor/docu
Update docs configuration files
@codecov

This comment has been minimized.

Copy link

codecov bot commented Apr 2, 2019

Codecov Report

Merging #374 into master will not change coverage.
The diff coverage is 93.75%.

@@           Coverage Diff           @@
##           master     #374   +/-   ##
=======================================
  Coverage   72.69%   72.69%           
=======================================
  Files          51       51           
  Lines       10574    10574           
=======================================
  Hits         7687     7687           
  Misses       2887     2887
@codecov

This comment has been minimized.

Copy link

codecov bot commented Apr 2, 2019

Codecov Report

Merging #374 into master will not change coverage.
The diff coverage is 88.23%.

@@           Coverage Diff           @@
##           master     #374   +/-   ##
=======================================
  Coverage   72.69%   72.69%           
=======================================
  Files          51       51           
  Lines       10574    10574           
=======================================
  Hits         7687     7687           
  Misses       2887     2887

tmmsartor and others added some commits Apr 3, 2019

Merge pull request #16 from tmmsartor/docu
docs: Fix getting_started
@roversch

This comment has been minimized.

Copy link
Contributor

roversch commented Apr 5, 2019

Hallelujah 👍

@zanellia

This comment has been minimized.

Copy link
Member Author

zanellia commented Apr 9, 2019

@giaf can we merge this? The web page will not be public yet anyway.

@giaf

This comment has been minimized.

Copy link
Collaborator

giaf commented Apr 9, 2019

@zanellia first of all, I rarely read emails coming from github as they are way too many and end up in a special (unread) folder, so just ping me with other means ;)

I had a look and it seems that no source code is touched (except comments), if so feel free to merge. If not, point me to the changes in source code :p

@zanellia zanellia merged commit c19e8af into acados:master Apr 11, 2019

4 checks passed

codecov/patch 88.23% of diff hit (target 0%)
Details
codecov/project 72.69% (target 0%)
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.