From 4493b86a4a19f20c2dc543ddb8537026e4393cf7 Mon Sep 17 00:00:00 2001 From: Alex Kavanagh Date: Thu, 28 Sep 2017 17:02:11 -0400 Subject: [PATCH] Move doc to deploy-guide for the documenation And remove the build-sphinx part of the python module setup as there are no docs to build. This is to make this project (which has no project documenation, but does have a deploy-guide) compatible with the other deploy-guides. Depends-On: I96d8e3d958081667df5e69e148e13c6b27c34767 Change-Id: If775b98b4a58cc956e487a6d566d62999eaaf12d --- README.rst | 4 ++-- {doc => deploy-guide}/source/conf.py | 0 {doc => deploy-guide}/source/config-openstack.rst | 0 {doc => deploy-guide}/source/index.rst | 0 {doc => deploy-guide}/source/install-juju.rst | 0 {doc => deploy-guide}/source/install-maas.rst | 0 .../source/install-openstack-bundle.rst | 0 {doc => deploy-guide}/source/install-openstack.rst | 0 .../source/media/config-openstack_images.png | Bin .../source/media/install-juju_maaskey.png | Bin .../source/media/install-maas_dhcp.png | Bin .../source/media/install-maas_discovery.png | Bin .../source/media/install-maas_images.png | Bin .../source/media/install-maas_imagestatus.png | Bin .../source/media/install-maas_noadmin.png | Bin .../source/media/install-maas_power.png | Bin .../source/media/install-maas_sshkeys.png | Bin .../source/media/install-maas_tags.png | Bin .../source/media/install-maas_welcome.png | Bin .../source/media/install-openstack_horizon.png | Bin setup.cfg | 5 ----- tox.ini | 2 +- 22 files changed, 3 insertions(+), 8 deletions(-) rename {doc => deploy-guide}/source/conf.py (100%) rename {doc => deploy-guide}/source/config-openstack.rst (100%) rename {doc => deploy-guide}/source/index.rst (100%) rename {doc => deploy-guide}/source/install-juju.rst (100%) rename {doc => deploy-guide}/source/install-maas.rst (100%) rename {doc => deploy-guide}/source/install-openstack-bundle.rst (100%) rename {doc => deploy-guide}/source/install-openstack.rst (100%) rename {doc => deploy-guide}/source/media/config-openstack_images.png (100%) rename {doc => deploy-guide}/source/media/install-juju_maaskey.png (100%) rename {doc => deploy-guide}/source/media/install-maas_dhcp.png (100%) rename {doc => deploy-guide}/source/media/install-maas_discovery.png (100%) rename {doc => deploy-guide}/source/media/install-maas_images.png (100%) rename {doc => deploy-guide}/source/media/install-maas_imagestatus.png (100%) rename {doc => deploy-guide}/source/media/install-maas_noadmin.png (100%) rename {doc => deploy-guide}/source/media/install-maas_power.png (100%) rename {doc => deploy-guide}/source/media/install-maas_sshkeys.png (100%) rename {doc => deploy-guide}/source/media/install-maas_tags.png (100%) rename {doc => deploy-guide}/source/media/install-maas_welcome.png (100%) rename {doc => deploy-guide}/source/media/install-openstack_horizon.png (100%) diff --git a/README.rst b/README.rst index bfab8cb..489f09b 100644 --- a/README.rst +++ b/README.rst @@ -15,6 +15,6 @@ To build the guide, execute the following command:: $ tox -After running ``tox``, the documentation will be available for viewing -in HTML format in the ``doc/build/`` directory. View these new documents +After running ``tox``, the documentation will be available for viewing in HTML +format in the ``deploy-guide/build/html`` directory. View these new documents in your favorite web browser. diff --git a/doc/source/conf.py b/deploy-guide/source/conf.py similarity index 100% rename from doc/source/conf.py rename to deploy-guide/source/conf.py diff --git a/doc/source/config-openstack.rst b/deploy-guide/source/config-openstack.rst similarity index 100% rename from doc/source/config-openstack.rst rename to deploy-guide/source/config-openstack.rst diff --git a/doc/source/index.rst b/deploy-guide/source/index.rst similarity index 100% rename from doc/source/index.rst rename to deploy-guide/source/index.rst diff --git a/doc/source/install-juju.rst b/deploy-guide/source/install-juju.rst similarity index 100% rename from doc/source/install-juju.rst rename to deploy-guide/source/install-juju.rst diff --git a/doc/source/install-maas.rst b/deploy-guide/source/install-maas.rst similarity index 100% rename from doc/source/install-maas.rst rename to deploy-guide/source/install-maas.rst diff --git a/doc/source/install-openstack-bundle.rst b/deploy-guide/source/install-openstack-bundle.rst similarity index 100% rename from doc/source/install-openstack-bundle.rst rename to deploy-guide/source/install-openstack-bundle.rst diff --git a/doc/source/install-openstack.rst b/deploy-guide/source/install-openstack.rst similarity index 100% rename from doc/source/install-openstack.rst rename to deploy-guide/source/install-openstack.rst diff --git a/doc/source/media/config-openstack_images.png b/deploy-guide/source/media/config-openstack_images.png similarity index 100% rename from doc/source/media/config-openstack_images.png rename to deploy-guide/source/media/config-openstack_images.png diff --git a/doc/source/media/install-juju_maaskey.png b/deploy-guide/source/media/install-juju_maaskey.png similarity index 100% rename from doc/source/media/install-juju_maaskey.png rename to deploy-guide/source/media/install-juju_maaskey.png diff --git a/doc/source/media/install-maas_dhcp.png b/deploy-guide/source/media/install-maas_dhcp.png similarity index 100% rename from doc/source/media/install-maas_dhcp.png rename to deploy-guide/source/media/install-maas_dhcp.png diff --git a/doc/source/media/install-maas_discovery.png b/deploy-guide/source/media/install-maas_discovery.png similarity index 100% rename from doc/source/media/install-maas_discovery.png rename to deploy-guide/source/media/install-maas_discovery.png diff --git a/doc/source/media/install-maas_images.png b/deploy-guide/source/media/install-maas_images.png similarity index 100% rename from doc/source/media/install-maas_images.png rename to deploy-guide/source/media/install-maas_images.png diff --git a/doc/source/media/install-maas_imagestatus.png b/deploy-guide/source/media/install-maas_imagestatus.png similarity index 100% rename from doc/source/media/install-maas_imagestatus.png rename to deploy-guide/source/media/install-maas_imagestatus.png diff --git a/doc/source/media/install-maas_noadmin.png b/deploy-guide/source/media/install-maas_noadmin.png similarity index 100% rename from doc/source/media/install-maas_noadmin.png rename to deploy-guide/source/media/install-maas_noadmin.png diff --git a/doc/source/media/install-maas_power.png b/deploy-guide/source/media/install-maas_power.png similarity index 100% rename from doc/source/media/install-maas_power.png rename to deploy-guide/source/media/install-maas_power.png diff --git a/doc/source/media/install-maas_sshkeys.png b/deploy-guide/source/media/install-maas_sshkeys.png similarity index 100% rename from doc/source/media/install-maas_sshkeys.png rename to deploy-guide/source/media/install-maas_sshkeys.png diff --git a/doc/source/media/install-maas_tags.png b/deploy-guide/source/media/install-maas_tags.png similarity index 100% rename from doc/source/media/install-maas_tags.png rename to deploy-guide/source/media/install-maas_tags.png diff --git a/doc/source/media/install-maas_welcome.png b/deploy-guide/source/media/install-maas_welcome.png similarity index 100% rename from doc/source/media/install-maas_welcome.png rename to deploy-guide/source/media/install-maas_welcome.png diff --git a/doc/source/media/install-openstack_horizon.png b/deploy-guide/source/media/install-openstack_horizon.png similarity index 100% rename from doc/source/media/install-openstack_horizon.png rename to deploy-guide/source/media/install-openstack_horizon.png diff --git a/setup.cfg b/setup.cfg index d81eb55..a6f77fc 100644 --- a/setup.cfg +++ b/setup.cfg @@ -11,11 +11,6 @@ classifier = License :: OSI Approved :: Apache Software License Operating System :: POSIX :: Linux -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source - [pbr] warnerrors = True diff --git a/tox.ini b/tox.ini index 155d411..74310da 100644 --- a/tox.ini +++ b/tox.ini @@ -14,4 +14,4 @@ deps = -r{toxinidir}/requirements.txt commands = {posargs} [testenv:deploy-guide] -commands = sphinx-build -a -d doc/build/doctrees -b html doc/source deploy-guide/build/html +commands = sphinx-build -a -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html