docs/conf.py

   1 import os
   2 import sys
   3 from docs_conf.conf import *
   4
   5 # autodoc needs this to find the code
   6 sys.path.insert(0, os.path.abspath("../"))
   7
   8 extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", "numpydoc"]
   9
  10 # don't alphabetically order
  11 autodoc_member_order = "bysource"
  12 # Tell numpydoc NOT to generate a list of class members to silence sphinx warnings like this:
  13 # simple.py:docstring of simple.simple.Simple.rst:20:autosummary: stub file not found 'simple.simple.Simple.hello'. Check your autosummary_generate setting.
  14 numpydoc_show_class_members = False
  15
  16 linkcheck_ignore = ["http://localhost.*", "http://127.0.0.1.*", "https://gerrit.o-ran-sc.org.*"]
  17
  18 # silence complaints from autodoc gen
  19 nitpick_ignore = [
  20             ('py:class', 'ctypes.c_char_p'),
  21             ('py:class', 'ctypes.c_void_p'),
  22             ('py:class', 'ricxappframe.rmr.rmr.LP_rmr_mbuf_t'),
  23             ]
  24
  25 # RMR c library is not available in ReadTheDocs
  26 autodoc_mock_imports = ['ricxappframe.rmr.rmrclib']
  27
  28 # Supports links to RMR man pages
  29 branch = 'latest'
  30 intersphinx_mapping['ric-plt-lib-rmr'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-lib-rmr/en/%s' % branch, None)