RIC-642 related changes: REST subscription, rnib enhancements, symptomdata, rest...

[ric-plt/xapp-frame-py.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 47e5eb7..6a252b0 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -5,10 +5,15 @@ 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"]
+language = 'en'
+
+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 +26,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)