Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 1 | import os |
| 2 | import sys |
Tommy Carpenter | 53786ca | 2020-02-28 09:17:46 -0500 | [diff] [blame] | 3 | from docs_conf.conf import * |
| 4 | |
Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame] | 5 | # autodoc needs this to find the code |
Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 6 | sys.path.insert(0, os.path.abspath("../")) |
| 7 | |
Lott, Christopher (cl778h) | f55e4d8 | 2020-04-10 16:02:11 -0400 | [diff] [blame] | 8 | extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", "numpydoc"] |
Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 9 | |
Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame] | 10 | # don't alphabetically order |
Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 11 | autodoc_member_order = "bysource" |
Lott, Christopher (cl778h) | ca170d3 | 2020-05-12 15:05:59 -0400 | [diff] [blame] | 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 |
Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 15 | |
Tommy Carpenter | 53786ca | 2020-02-28 09:17:46 -0500 | [diff] [blame] | 16 | linkcheck_ignore = ["http://localhost.*", "http://127.0.0.1.*", "https://gerrit.o-ran-sc.org.*"] |
Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame] | 17 | |
| 18 | # silence complaints from autodoc gen |
Lott, Christopher (cl778h) | 4b9552c | 2020-04-09 14:49:02 -0400 | [diff] [blame] | 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 | ] |
Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame] | 24 | |
| 25 | # RMR c library is not available in ReadTheDocs |
| 26 | autodoc_mock_imports = ['ricxappframe.rmr.rmrclib'] |
Lott, Christopher (cl778h) | f55e4d8 | 2020-04-10 16:02:11 -0400 | [diff] [blame] | 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) |