Skip to content
Snippets Groups Projects

doc: support sphinx 3.0.0+

Merged Tomas Krizek requested to merge sphinx-v3 into master
All threads resolved!

It seems the :function: directive is much stricter now and requires valid C declaration. The lua functions seem to work okay with :py-function:. Some of the doxygen generated content was invalid and required various hacks. Now it's working, but I had to omit some symbols.

This should hopefully fix readthedocs issue we're experiencing right now (https://github.com/michaeljones/breathe/issues/495) by switching to sphinx 3.0.0+ in readhthedocs.

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • For testing I activated building of this branch on our readthedocs.org and it succeeded.

  • Replacing the large diff by default-domain:: py would be nice, I think.

  • Tomas Krizek added 16 commits

    added 16 commits

    • 1e10c539...eb2b03df - 8 commits from branch master
    • 1f92ece9 - doc/doxygen: configure macro expansion and edge cases
    • 7962a452 - lib/utils: ensure consistent use of KR_* macros
    • 71dfc75a - lib/rplan: clean up codestyle for doxygen
    • b2f8f894 - doc/upgrading: reword to use new-style C reference
    • 1ed03734 - doc/policy: make sure only one reference to rpz() exists
    • ce3ba294 - doc/lib: add warning about potential doc inaccuracies
    • 750102b6 - doc: use sphinx 3.0.0+ on readthedocs
    • 64d01ed8 - doc: use python as default domain

    Compare with previous version

  • I've changed the primary domain to py and it seems to do the trick. Build passes: https://readthedocs.org/projects/knot-resolver/builds/10839461/

  • Vladimír Čunát resolved all threads

    resolved all threads

  • Vladimír Čunát added 10 commits

    added 10 commits

    • 64d01ed8...ee0827ce - 2 commits from branch master
    • 795eead2 - doc/doxygen: configure macro expansion and edge cases
    • 2b4d28b5 - lib/utils: ensure consistent use of KR_* macros
    • b946c94a - lib/rplan: clean up codestyle for doxygen
    • eb942ea0 - doc/upgrading: reword to use new-style C reference
    • 9aa3f574 - doc/policy: make sure only one reference to rpz() exists
    • f9113b6e - doc/lib: add warning about potential doc inaccuracies
    • 8f5af2d3 - doc: use sphinx 3.0.0+ on readthedocs
    • 13ac2252 - doc: use python as default domain

    Compare with previous version

  • Vladimír Čunát
  • Vladimír Čunát resolved all threads

    resolved all threads

  • mentioned in commit aa9e9287

  • Please register or sign in to reply
    Loading