FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: add readthedocs doxygen wrapper by smlng · Pull Request #119 · rtrlib/rtrlib · GitHub

/ rtrlib Public

docs: add readthedocs doxygen wrapper - #119

Open
smlng wants to merge 4 commits into
rtrlib:masterfrom
smlng:docs/rtd
Open

docs: add readthedocs doxygen wrapper#119
smlng wants to merge 4 commits into
rtrlib:masterfrom
smlng:docs/rtd

Conversation

smlng commented Mar 28, 2017

Copy link
Copy Markdown
Member

addressed #118

This may need some work. Currently it shows (lots of) errors during generation, and the output is single-page -> hence, a bit unstructured.

codecov-io commented Mar 28, 2017
edited
Loading

Copy link
Copy Markdown

Codecov Report

Merging #119 into master will decrease coverage by 3.54%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #119      +/-   ##
==========================================
- Coverage    67.7%   64.15%   -3.55%     
==========================================
  Files          16       14       -2     
  Lines        2149     1928     -221     
  Branches      369      367       -2     
==========================================
- Hits         1455     1237     -218     
+ Misses        694      691       -3

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 621aee0...7e2f589. Read the comment docs.

Copy link
Copy Markdown
Member

@smlng thanks. Can you provide a readthedocs link to a preview? When do you will fix the errors?

Btw, now we have two Doxyfile, which might be confusing. Should be cleaned up later.

smlng commented Mar 28, 2017

Copy link
Copy Markdown
Member Author

Regarding the 2 Doxyfiles: I'm not sure if they can be merged into one, the problem is that doxygen/Doxyfile is used by the Cmake toolchain and docs/Doxyfile is for the RTD intgeration, which needs some adaptions for output params and paths.

smlng commented Mar 29, 2017

Copy link
Copy Markdown
Member Author

@waehlisch I put a demo side online, have a look here.

Regarding the errors, I see during doc generation: most of them are related to undocumented code parts (functions, parameters, and so on), some are readthedocs + breathe related, but not severe.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants


Back | FazBrowse Home | New Git URL