Move wrapped C library to subpackage

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

diff --git a/docs/conf.py b/docs/conf.py
old mode 100644 (file)
new mode 100755 (executable)
index 974c309..47e5eb7
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,3 +1,23 @@
+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"]
+
+# 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']