X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=d695a9a09749deb0631bc4a8e89808ea7947c4a7;hb=e2e3e435babf3aeb8c1bae14ad2a055d02bee38a;hp=5b443e9fe417c814e235715beed82e83dcca0355;hpb=fbb5928134d64dbab8bc3e64b23c2f21e4c4be6f;p=ric-plt%2Fxapp-frame-py.git diff --git a/docs/conf.py b/docs/conf.py old mode 100644 new mode 100755 index 5b443e9..d695a9a --- a/docs/conf.py +++ b/docs/conf.py @@ -2,11 +2,26 @@ import os import sys from docs_conf.conf import * +# autodoc needs this to find the code sys.path.insert(0, os.path.abspath("../")) -extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "numpydoc"] +extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", "numpydoc"] -# dont alphabetically order +# don't alphabetically order autodoc_member_order = "bysource" linkcheck_ignore = ["http://localhost.*", "http://127.0.0.1.*", "https://gerrit.o-ran-sc.org.*"] + +# silence complaints from autodoc gen +nitpick_ignore = [ + ('py:class', 'ctypes.c_char_p'), + ('py:class', 'ctypes.c_void_p'), + ('py:class', 'ricxappframe.rmr.rmr.LP_rmr_mbuf_t'), + ] + +# RMR c library is not available in ReadTheDocs +autodoc_mock_imports = ['ricxappframe.rmr.rmrclib'] + +# Supports links to RMR man pages +branch = 'latest' +intersphinx_mapping['ric-plt-lib-rmr'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-lib-rmr/en/%s' % branch, None)