X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=ccad5c3ea57853be6c606711bdb1202f9c7db07e;hb=refs%2Fheads%2Fbronze;hp=974c30919f10bb59197cff40ef1690c4467f4e0f;hpb=53786ca4caf3382ebcbab10f25a993db23b4d99f;p=ric-plt%2Fxapp-frame-py.git

diff --git a/docs/conf.py b/docs/conf.py
old mode 100644
new mode 100755
index 974c309..ccad5c3
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,3 +1,30 @@
+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.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.*"]
+
+# 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)