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

Fix documentation generation #598

Closed
wants to merge 2 commits into from
Closed

Fix documentation generation #598

wants to merge 2 commits into from

Conversation

kelson42
Copy link
Contributor

@kelson42 kelson42 commented Jul 31, 2021

Fixes #595

@codecov
Copy link

codecov bot commented Jul 31, 2021

Codecov Report

Merging #598 (7d790eb) into master (855dfe0) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #598   +/-   ##
=======================================
  Coverage   82.78%   82.78%           
=======================================
  Files          91       91           
  Lines        3822     3822           
  Branches     1703     1703           
=======================================
  Hits         3164     3164           
  Misses        657      657           
  Partials        1        1           
Impacted Files Coverage Δ
include/zim/search.h 100.00% <ø> (ø)
include/zim/search_iterator.h 100.00% <ø> (ø)

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 855dfe0...7d790eb. Read the comment docs.

@kelson42
Copy link
Contributor Author

kelson42 commented Jul 31, 2021

@mgautierfr Now it passes for me localy but it fails on the CI! Like stated earlier by @maneeshpm #574 (comment), my own research tends to lead to sphinx-doc/sphinx#9433 and breathe-doc/breathe#711

@kelson42 kelson42 force-pushed the doc_fix branch 3 times, most recently from 5fc8a1e to f9f5beb Compare July 31, 2021 15:52
@kelson42
Copy link
Contributor Author

kelson42 commented Jul 31, 2021

I have tried to setup a .readthedocs.yml, without success. Looks like ReadTheDocs is using an old version of Doxygen and the problem might come from there.

@maneeshpm
Copy link
Collaborator

@kelson42 I believe you are correct. Can we try specifying the version of doxygen(the latest one) or the version of sphinx(the previous version) on our side?

@kelson42
Copy link
Contributor Author

@maneeshpm I don't know how, not even sure this is possible

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

Successfully merging this pull request may close these issues.

Documentation is broken
2 participants