doc: support sphinx 3.0.0+
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
Activity
changed milestone to %5.1.0
I think you need Sphinx directive
.. default-domain:: py
, see https://gitlab.labs.nic.cz/knot/knot-resolver/-/blob/master/modules/policy/README.rst#L3- Resolved by Vladimír Čunát
For testing I activated building of this branch on our readthedocs.org and it succeeded.
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
Toggle commit list-
1e10c539...eb2b03df - 8 commits from branch
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/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
Toggle commit list-
64d01ed8...ee0827ce - 2 commits from branch
- Resolved by Vladimír Čunát
mentioned in commit aa9e9287