X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=ccad5c3ea57853be6c606711bdb1202f9c7db07e;hb=bac18952225035e44ae7672b81dacc2793944a16;hp=47e5eb719340b4207c8d04d52758b87436e571ad;hpb=db26ba217530985dbdcf739640c16c6cecd54a1d;p=ric-plt%2Fxapp-frame-py.git diff --git a/docs/conf.py b/docs/conf.py index 47e5eb7..ccad5c3 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -5,10 +5,13 @@ 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"] # don't alphabetically order autodoc_member_order = "bysource" +# Tell numpydoc NOT to generate a list of class members to silence sphinx warnings like this: +# simple.py:docstring of simple.simple.Simple.rst:20:autosummary: stub file not found 'simple.simple.Simple.hello'. Check your autosummary_generate setting. +numpydoc_show_class_members = False linkcheck_ignore = ["http://localhost.*", "http://127.0.0.1.*", "https://gerrit.o-ran-sc.org.*"] @@ -21,3 +24,7 @@ nitpick_ignore = [ # 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)