From 3d816ede996897281259cb2bc73ca4ddc857cf15 Mon Sep 17 00:00:00 2001 From: Lucian Petrut Date: Wed, 7 Feb 2018 10:24:32 +0200 Subject: [PATCH] Prepare for readthedocs Since compute-hyperv is not an official OpenStack project, we cannot host our docs on docs.openstack.org. For this reason, we'll use readthedocs. As readthedocs will not use tox, we have to explicitly provide the doc build requirements that are not included in requirements.txt. Unfortunately, we'll have to update this file manually at least once per release. Also, reathedocs will invoke sphinx-doc from the /doc dir, for which reason it cannot find etc/compute-hyperv-config-generator.conf. The according reference is updated, explicitly declaring the namespaces to be used when generating the config reference. Change-Id: Idab6f10f92f7f2e40962f1cabaac8691e6c46619 --- .docs-requirements.txt | 23 +++++++++++++++++++++++ doc/source/configuration/config.rst | 8 +++++++- 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 .docs-requirements.txt diff --git a/.docs-requirements.txt b/.docs-requirements.txt new file mode 100644 index 00000000..297a1cfa --- /dev/null +++ b/.docs-requirements.txt @@ -0,0 +1,23 @@ +# As ``readthedocs`` will not use tox, we have to explicitly provide the doc +# build requirements that are not included in requirements.txt. +# +# Unfortunately, we'll have to update this file manually at least once per +# release. + +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +# We'll have to make sure that the nova branch matches the compute-hyperv one. +-e git+http://github.com/openstack/nova.git#egg=nova + +hacking<0.13,>=0.12.0 # Apache-2.0 + +coverage!=4.4,>=4.0 # Apache-2.0 +sphinx!=1.6.6,>=1.6.2 # BSD +oslo.config>=5.1.0 # Apache-2.0 +oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.18.1 # Apache-2.0 + +# releasenotes +reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/configuration/config.rst b/doc/source/configuration/config.rst index 2fa6b7c0..490bc48e 100644 --- a/doc/source/configuration/config.rst +++ b/doc/source/configuration/config.rst @@ -7,4 +7,10 @@ and compute-hyperv. For a sample configuration file, refer to :ref:`config_sample`. .. show-options:: - :config-file: etc/compute-hyperv-config-generator.conf + + compute_hyperv + os_win + nova.conf + oslo.log + oslo.messaging + oslo.concurrency