Fix: Promenade Exceptions docs rendering on RTD
Readthedocs failed to render Promenade exceptions with error: > WARNING: autodoc: failed to import exception 'xxx' from module > 'promenade'; the following exception was raised: No module > named 'falcon' Trying to add Promenade requirements to the installed requirements list, so that Readthedocs has all modules, including those needed for the Promenade itself. Unify docs building by utilizing Zuul docs-on-readthedocs template job. Cosmetic readability changes: 1. combined all Makefile .PHONY targets into one 2. merged multiple LABEL instructions in Dockerfile into one Change-Id: I731ee3426a631fa765f13ba7091dcb4b9ebd0353
This commit is contained in:
Roman Gorshunov
parent
b3533b8522
commit
d12927a156
27
.readthedocs.yaml
Normal file
27
.readthedocs.yaml
Normal file
@ -0,0 +1,27 @@
|
||||
# .readthedocs.yml
|
||||
# Read the Docs configuration file
|
||||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
||||
|
||||
# Required
|
||||
version: 2
|
||||
|
||||
# Build documentation in the doc/ directory with Sphinx
|
||||
sphinx:
|
||||
configuration: doc/source/conf.py
|
||||
|
||||
# Build documentation with MkDocs
|
||||
#mkdocs:
|
||||
# configuration: mkdocs.yml
|
||||
|
||||
# Optionally build your docs in additional formats such as PDF and ePub
|
||||
formats:
|
||||
- pdf
|
||||
|
||||
# Optionally set the version of Python and requirements required to build your docs
|
||||
python:
|
||||
version: 3.7
|
||||
install:
|
||||
- requirements: doc/requirements.txt
|
||||
- requirements: requirements.txt
|
||||
- requirements: requirements-direct.txt
|
||||
- requirements: requirements-frozen.txt
|
||||
20
.zuul.yaml
20
.zuul.yaml
@ -11,12 +11,16 @@
|
||||
# limitations under the License.
|
||||
|
||||
- project:
|
||||
templates:
|
||||
- docs-on-readthedocs
|
||||
vars:
|
||||
rtd_webhook_id: '38575'
|
||||
rtd_project_name: 'airship-promenade'
|
||||
check:
|
||||
jobs:
|
||||
- openstack-tox-pep8
|
||||
- airship-promenade-lint-ws
|
||||
- airship-promenade-docker-build-gate
|
||||
- airship-promenade-doc-build
|
||||
- airship-promenade-chart-build-gate
|
||||
- airship-promenade-chart-build-latest-htk
|
||||
- airship-promenade-unit-py35
|
||||
@ -27,7 +31,6 @@
|
||||
- openstack-tox-pep8
|
||||
- airship-promenade-lint-ws
|
||||
- airship-promenade-docker-build-gate
|
||||
- airship-promenade-doc-build
|
||||
- airship-promenade-chart-build-gate
|
||||
- airship-promenade-unit-py35
|
||||
- airship-promenade-genesis-gate
|
||||
@ -88,19 +91,6 @@
|
||||
files:
|
||||
- ^.*\.py$
|
||||
|
||||
- job:
|
||||
name: airship-promenade-doc-build
|
||||
description: |
|
||||
Locally build the documentation to check for errors
|
||||
run: tools/zuul/playbooks/doc-build.yaml
|
||||
timeout: 300
|
||||
nodeset: airship-promenade-single-node
|
||||
irrelevant-files:
|
||||
- ^charts/.*$
|
||||
- ^etc/.*$
|
||||
- ^tests/.*$
|
||||
- ^tools/.*$
|
||||
|
||||
- job:
|
||||
name: airship-promenade-linter
|
||||
run: tools/zuul/playbooks/zuul-linter.yaml
|
||||
|
||||
12
Dockerfile
12
Dockerfile
@ -15,12 +15,12 @@
|
||||
ARG FROM=python:3.6
|
||||
FROM ${FROM}
|
||||
|
||||
LABEL org.opencontainers.image.authors='airship-discuss@lists.airshipit.org, irc://#airshipit@freenode'
|
||||
LABEL org.opencontainers.image.url='https://airshipit.org'
|
||||
LABEL org.opencontainers.image.documentation='https://airship-promenade.readthedocs.org'
|
||||
LABEL org.opencontainers.image.source='https://git.openstack.org/openstack/airship-promenade'
|
||||
LABEL org.opencontainers.image.vendor='The Airship Authors'
|
||||
LABEL org.opencontainers.image.licenses='Apache-2.0'
|
||||
LABEL org.opencontainers.image.authors='airship-discuss@lists.airshipit.org, irc://#airshipit@freenode' \
|
||||
org.opencontainers.image.url='https://airshipit.org' \
|
||||
org.opencontainers.image.documentation='https://airship-promenade.readthedocs.org' \
|
||||
org.opencontainers.image.source='https://git.openstack.org/openstack/airship-promenade' \
|
||||
org.opencontainers.image.vendor='The Airship Authors' \
|
||||
org.opencontainers.image.licenses='Apache-2.0'
|
||||
|
||||
VOLUME /etc/promenade
|
||||
VOLUME /target
|
||||
|
||||
32
Makefile
32
Makefile
@ -34,90 +34,69 @@ HELM_PIDFILE ?= $(abspath ./.helm-pid)
|
||||
|
||||
CHARTS := $(patsubst charts/%/.,%,$(wildcard charts/*/.))
|
||||
|
||||
.PHONY: all
|
||||
all: charts lint
|
||||
|
||||
.PHONY: tests
|
||||
tests: external-deps gate-lint
|
||||
tox
|
||||
|
||||
.PHONY: tests-security
|
||||
tests-security:
|
||||
tox -e bandit
|
||||
|
||||
.PHONY: docs
|
||||
docs:
|
||||
docs: clean
|
||||
tox -e docs
|
||||
|
||||
.PHONY: tests-unit
|
||||
tests-unit: external-deps
|
||||
tox -e py35
|
||||
|
||||
.PHONY: external-deps
|
||||
external-deps:
|
||||
./tools/install-external-deps.sh
|
||||
|
||||
.PHONY: tests-pep8
|
||||
tests-pep8:
|
||||
tox -e pep8
|
||||
|
||||
chartbanner:
|
||||
@echo Building charts: $(CHARTS)
|
||||
|
||||
.PHONY: charts
|
||||
charts: $(CHARTS)
|
||||
@echo Done building charts.
|
||||
|
||||
.PHONY: helm-init
|
||||
helm-init: $(addprefix helm-init-,$(CHARTS))
|
||||
|
||||
.PHONY: helm-init-%
|
||||
helm-init-%: helm-serve
|
||||
@echo Initializing chart $*
|
||||
cd charts;if [ -s $*/requirements.yaml ]; then echo "Initializing $*";$(HELM) dep up $*; fi
|
||||
|
||||
.PHONY: lint
|
||||
lint: helm-lint gate-lint
|
||||
|
||||
.PHONY: gate-lint
|
||||
gate-lint: gate-lint-deps
|
||||
tox -e gate-lint
|
||||
|
||||
.PHONY: gate-lint-deps
|
||||
gate-lint-deps:
|
||||
sudo apt-get install -y --no-install-recommends shellcheck
|
||||
|
||||
.PHONY: helm-lint
|
||||
helm-lint: $(addprefix helm-lint-,$(CHARTS))
|
||||
|
||||
.PHONY: helm-lint-%
|
||||
helm-lint-%: helm-install helm-init-%
|
||||
@echo Linting chart $*
|
||||
cd charts;$(HELM) lint $*
|
||||
|
||||
.PHONY: images
|
||||
images: check-docker build_promenade
|
||||
|
||||
.PHONY: check-docker
|
||||
check-docker:
|
||||
@if [ -z $$(which docker) ]; then \
|
||||
echo "Missing \`docker\` client which is required for development"; \
|
||||
exit 2; \
|
||||
fi
|
||||
|
||||
.PHONY: dry-run
|
||||
dry-run: $(addprefix dry-run-,$(CHARTS))
|
||||
|
||||
.PHONY: dry-run-%
|
||||
dry-run-%: helm-lint-%
|
||||
echo Running Dry-Run on chart $*
|
||||
cd charts;$(HELM) template --set pod.resources.enabled=true $*
|
||||
|
||||
.PHONY: $(CHARTS)
|
||||
$(CHARTS): $(addprefix dry-run-,$(CHARTS)) chartbanner
|
||||
$(HELM) package -d charts charts/$@
|
||||
|
||||
.PHONY: build_promenade
|
||||
build_promenade:
|
||||
ifeq ($(USE_PROXY), true)
|
||||
docker build --network host -t $(IMAGE) --label $(LABEL) \
|
||||
@ -145,17 +124,20 @@ ifeq ($(PUSH_IMAGE), true)
|
||||
endif
|
||||
|
||||
|
||||
.PHONY: helm-serve
|
||||
helm-serve: helm-install
|
||||
./tools/helm_tk.sh $(HELM) $(HELM_PIDFILE)
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -rf doc/build
|
||||
rm -f charts/*.tgz
|
||||
rm -f charts/*/requirements.lock
|
||||
rm -rf charts/*/charts
|
||||
|
||||
# Install helm binary
|
||||
.PHONY: helm-install
|
||||
helm-install:
|
||||
tools/helm_install.sh $(HELM)
|
||||
|
||||
.PHONY: $(CHARTS) all build_promenade charts check-docker clean docs \
|
||||
dry-run dry-run-% external-deps gate-lint gate-lint-deps helm-init \
|
||||
helm-init-% helm-install helm-lint helm-lint-% helm-serve images \
|
||||
lint tests tests-pep8 tests-security tests-unit
|
||||
|
||||
@ -18,32 +18,34 @@
|
||||
Promenade Exceptions
|
||||
====================
|
||||
|
||||
.. autoexception:: promenade.exceptions.ApiError
|
||||
.. currentmodule:: promenade.exceptions
|
||||
|
||||
.. autoexception:: ApiError
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
.. autoexception:: promenade.exceptions.InvalidFormatError
|
||||
.. autoexception:: InvalidFormatError
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
.. autoexception:: promenade.exceptions.ValidationException
|
||||
.. autoexception:: ValidationException
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
.. autoexception:: promenade.exceptions.KubernetesConfigException
|
||||
.. autoexception:: KubernetesConfigException
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
.. autoexception:: promenade.exceptions.KubernetesApiError
|
||||
.. autoexception:: KubernetesApiError
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
.. autoexception:: promenade.exceptions.NodeNotFoundException
|
||||
.. autoexception:: NodeNotFoundException
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
@ -1,20 +0,0 @@
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
- hosts: primary
|
||||
tasks:
|
||||
- name: Build documents locally
|
||||
make:
|
||||
chdir: "{{ zuul.project.src_dir }}"
|
||||
target: docs
|
||||
register: result
|
||||
failed_when: result.failed
|
||||
Loading…
x
Reference in New Issue
Block a user