summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFelipe Monteiro <felipe.monteiro@att.com>2018-10-26 10:57:55 -0400
committerFelipe Monteiro <felipe.monteiro@att.com>2018-10-27 15:21:54 +0000
commit018162f1ef6f1813454e113ab5679ca5086460d3 (patch)
treea3f4fc8e19a9f7f869039628f54c656a9bad8cd8
parent7defe473d2e1111ba1738610cbecaffd6ff6151d (diff)
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
Notes
Notes (review): Code-Review+2: Felipe Monteiro <felipe.monteiro@att.com> Workflow+1: Felipe Monteiro <felipe.monteiro@att.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Sat, 27 Oct 2018 15:37:21 +0000 Reviewed-on: https://review.openstack.org/613608 Project: openstack/airship-deckhand Branch: refs/heads/master
-rw-r--r--doc/requirements.txt6
-rw-r--r--doc/source/conf.py7
-rw-r--r--doc/source/images/architecture-pegleg.pngbin37600 -> 37602 bytes
-rw-r--r--doc/source/images/architecture.pngbin23230 -> 23232 bytes
4 files changed, 7 insertions, 6 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 280af85..f9e6b36 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,11 +2,7 @@
2# of appearance. Changing the order has an impact on the overall integration 2# of appearance. Changing the order has an impact on the overall integration
3# process, which may cause wedges in the gate later. 3# process, which may cause wedges in the gate later.
4sphinx>=1.6.2 # BSD 4sphinx>=1.6.2 # BSD
5sphinx_rtd_theme==0.2.4 5sphinx_rtd_theme
6reno>=2.5.0 # Apache-2.0 6reno>=2.5.0 # Apache-2.0
7plantuml 7plantuml
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.
11oslo.config!=4.3.0,!=4.4.0,>=5.2.0 # Apache-2.0
12oslo.policy>=1.33.1 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 372a92f..399dc0a 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -18,8 +18,13 @@
18# 18#
19import os 19import os
20import sys 20import sys
21sys.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.
25sys.path.insert(0, os.path.abspath('../../'))
22sys.path.insert(0, os.path.abspath('../')) 26sys.path.insert(0, os.path.abspath('../'))
27sys.path.insert(0, os.path.abspath('./'))
23 28
24# -- General configuration ------------------------------------------------ 29# -- General configuration ------------------------------------------------
25 30
diff --git a/doc/source/images/architecture-pegleg.png b/doc/source/images/architecture-pegleg.png
index ed0a368..85428fb 100644
--- a/doc/source/images/architecture-pegleg.png
+++ b/doc/source/images/architecture-pegleg.png
Binary files differ
diff --git a/doc/source/images/architecture.png b/doc/source/images/architecture.png
index 1ba9361..225a794 100644
--- a/doc/source/images/architecture.png
+++ b/doc/source/images/architecture.png
Binary files differ