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
This commit is contained in:
Lucian Petrut 2018-02-07 10:24:32 +02:00
parent ad53c88d4e
commit 3d816ede99
2 changed files with 30 additions and 1 deletions

23
.docs-requirements.txt Normal file
View File

@ -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

View File

@ -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