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