blob: ccad5c3ea57853be6c606711bdb1202f9c7db07e [file] [log] [blame]
Tommy Carpenterfbb59282020-04-08 07:04:51 -04001import os
2import sys
Tommy Carpenter53786ca2020-02-28 09:17:46 -05003from docs_conf.conf import *
4
Lott, Christopher (cl778h)db26ba22020-04-09 18:25:19 -04005# autodoc needs this to find the code
Tommy Carpenterfbb59282020-04-08 07:04:51 -04006sys.path.insert(0, os.path.abspath("../"))
7
Lott, Christopher (cl778h)f55e4d82020-04-10 16:02:11 -04008extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", "numpydoc"]
Tommy Carpenterfbb59282020-04-08 07:04:51 -04009
Lott, Christopher (cl778h)db26ba22020-04-09 18:25:19 -040010# don't alphabetically order
Tommy Carpenterfbb59282020-04-08 07:04:51 -040011autodoc_member_order = "bysource"
Lott, Christopher (cl778h)ca170d32020-05-12 15:05:59 -040012# 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.
14numpydoc_show_class_members = False
Tommy Carpenterfbb59282020-04-08 07:04:51 -040015
Tommy Carpenter53786ca2020-02-28 09:17:46 -050016linkcheck_ignore = ["http://localhost.*", "http://127.0.0.1.*", "https://gerrit.o-ran-sc.org.*"]
Lott, Christopher (cl778h)db26ba22020-04-09 18:25:19 -040017
18# silence complaints from autodoc gen
Lott, Christopher (cl778h)4b9552c2020-04-09 14:49:02 -040019nitpick_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 ]
Lott, Christopher (cl778h)db26ba22020-04-09 18:25:19 -040024
25# RMR c library is not available in ReadTheDocs
26autodoc_mock_imports = ['ricxappframe.rmr.rmrclib']
Lott, Christopher (cl778h)f55e4d82020-04-10 16:02:11 -040027
28# Supports links to RMR man pages
29branch = 'latest'
30intersphinx_mapping['ric-plt-lib-rmr'] = ('https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-lib-rmr/en/%s' % branch, None)