adds doxygen doc to gh_pages with a link from inside the shinx doc

CS-SI / SIRIUS

Sirius - Fast and simple to plug-in C++ resampling library that is taking advantage of the Fourier Transform

https://cs-si.github.io/SIRIUS/html/Sirius.html

GNU General Public License v3.0

6 stars 5 forks source link

adds doxygen doc to gh_pages with a link from inside the shinx doc #14

Closed dumasl closed 6 years ago

dumasl commented 6 years ago

I have been able to test it on a personal git branch by changing the encrypted github keys and everything related to the CS-SI repository. The result can be found here "https://dumasl.github.io/SIRIUS/html/Sirius.html". Link to C++ doxygen might still be referring to cs-si url here because of github pages latency. But one will see our the sphinx toctree integrates the C++ API title and then from where the doxygen will be accessed.

hlysunnaram commented 6 years ago

Doxygen doc seems broken (code blocks not parsed, missing main page) due to doxygen version used in the Docker container (1.8.5). Generation is ok with doxygen >= 1.8.11.
We should add a link to the doxygen documentation in the Overview section of README.md.
Typo spotted in the first line of .travis.yml
```
lannguage: python -> language: python
```
By the way, is this line really useful since we are using docker to build project and doc?

dumasl commented 6 years ago

The last commit is using a new docker image with 1.8.14 doxygen which fixes the issues. I am not sure about the link from the Overview section. Maybe we should consider the sphinx doc as the only doc to point to, without referring to it as the "Theoretical" doc. Then inside this doc one can find everything ? About the typo, it is actually not used. I think it was even ruby in previous version of it :) I suppose we could remove it definitely (i'll make that commit). By the way, the doxygen says this is Sirius 1.0.0 version... Is it ?

hlysunnaram commented 6 years ago

Sirius version is specified in the root CMakeLists.txt and forwarded to doxygen and sirius executable. It will be changed to 0.1.0 as @savmickael suggested.

Update: automated solution would be to extract version info directly from the most recent Git tag in the commit history with git describe

When no tag is present in the commit tree, set the version to 0.0.0