Browse Source

rtd: Fix warnings in RTD causing autodoc to fail

This patch set fixes warnings [0] in RTD which are causing autodoc
to fail to build, resulting in missing documentation as in
here: https://airship-deckhand.readthedocs.io/en/latest/operators/exceptions.html

Example warnings:

WARNING: autodoc: failed to import module 'deckhand.policy'; the following exception was raised:
No module named 'falcon'

[0] https://readthedocs.org/api/v2/build/8001684.txt

Change-Id: I872b90e03a8f9e3de3fd717ed340b53f095f01a5
Felipe Monteiro 5 months ago
parent
commit
018162f1ef

+ 1
- 5
doc/requirements.txt View File

@@ -2,11 +2,7 @@
2 2
 # of appearance. Changing the order has an impact on the overall integration
3 3
 # process, which may cause wedges in the gate later.
4 4
 sphinx>=1.6.2 # BSD
5
-sphinx_rtd_theme==0.2.4
5
+sphinx_rtd_theme
6 6
 reno>=2.5.0 # Apache-2.0
7 7
 plantuml
8 8
 
9
-# NOTE(fmontei): The requirement below is only included because readthedocs
10
-# depends on it to work, since it only takes in one requirements file.
11
-oslo.config!=4.3.0,!=4.4.0,>=5.2.0 # Apache-2.0
12
-oslo.policy>=1.33.1 # Apache-2.0

+ 6
- 1
doc/source/conf.py View File

@@ -18,8 +18,13 @@
18 18
 #
19 19
 import os
20 20
 import sys
21
-sys.path.insert(0, os.path.abspath('.'))
21
+
22
+# If extensions (or modules to document with autodoc) are in another directory,
23
+# add these directories to sys.path here. If the directory is relative to the
24
+# documentation root, use os.path.abspath to make it absolute, like shown here.
25
+sys.path.insert(0, os.path.abspath('../../'))
22 26
 sys.path.insert(0, os.path.abspath('../'))
27
+sys.path.insert(0, os.path.abspath('./'))
23 28
 
24 29
 # -- General configuration ------------------------------------------------
25 30
 

BIN
doc/source/images/architecture-pegleg.png View File


BIN
doc/source/images/architecture.png View File


Loading…
Cancel
Save