FirstApp: Move source directory up, rename top-level dir
For the RST guides, we do not need doc/source, since doc is always empty. Use source directly. This syncs the setup used here with openstack-manuals. Rename top-level from openstack-firstapp to firstapp, there's no need for the long name in this repo. Change-Id: If4e11a4f90d580876865348e0d88b92cec4b6659
This commit is contained in:
parent
e7040ded4f
commit
f58477ef61
2
.gitignore
vendored
2
.gitignore
vendored
@ -18,4 +18,4 @@ target/
|
||||
*~
|
||||
.*.swp
|
||||
.bak
|
||||
/openstack-firstapp/build*/
|
||||
/firstapp/build*/
|
||||
|
@ -33,5 +33,5 @@ DOC_DIR="./"
|
||||
# Values need to match content in project-config/jenkins/scripts/common_translation_update.sh
|
||||
declare -A SPECIAL_BOOKS
|
||||
SPECIAL_BOOKS=(
|
||||
["openstack-firstapp"]="skip"
|
||||
["firstapp"]="skip"
|
||||
)
|
||||
|
@ -8,15 +8,15 @@ tutorial.
|
||||
The tutorials works with an application that can be found at:
|
||||
https://github.com/stackforge/faafo
|
||||
|
||||
/doc
|
||||
~~~~
|
||||
/source
|
||||
~~~~~~~
|
||||
|
||||
The :code:`/doc` directory contains a playground for the actual tutorial
|
||||
The :code:`/source` directory contains a playground for the actual tutorial
|
||||
documentation. It's reStructuredText (RST), built with Sphinx.
|
||||
|
||||
The RST source includes conditional output logic, so specifying::
|
||||
|
||||
tox -e openstack-firstapp-libcloud
|
||||
tox -e firstapp-libcloud
|
||||
|
||||
will invoke :code:`sphinx-build` with :code:`-t libcloud`, meaning sections
|
||||
marked :code:`.. only:: libcloud` in the RST will be built, while others
|
@ -13,8 +13,8 @@ classifier =
|
||||
|
||||
[build_sphinx]
|
||||
all_files = 1
|
||||
build-dir = doc/build
|
||||
source-dir = doc/source
|
||||
build-dir = build
|
||||
source-dir = source
|
||||
|
||||
[pbr]
|
||||
warnerrors = True
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
Before Width: | Height: | Size: 202 KiB After Width: | Height: | Size: 202 KiB |
@ -178,7 +178,7 @@ initial version of the guide assume that you're using Libcloud.
|
||||
|
||||
.. only:: fog
|
||||
|
||||
.. literalinclude:: ../../samples/fog/section1.rb
|
||||
.. literalinclude:: ../samples/fog/section1.rb
|
||||
:start-after: step-1
|
||||
:end-before: step-2
|
||||
|
||||
@ -187,7 +187,7 @@ initial version of the guide assume that you're using Libcloud.
|
||||
To try it, add the following code to a Python script (or use an
|
||||
interactive Python shell) by calling :code:`python -i`.
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-1
|
||||
:end-before: step-2
|
||||
|
||||
@ -230,13 +230,13 @@ To list the images that are available in your cloud, run some API calls:
|
||||
|
||||
.. only:: fog
|
||||
|
||||
.. literalinclude:: ../../samples/fog/section1.rb
|
||||
.. literalinclude:: ../samples/fog/section1.rb
|
||||
:start-after: step-2
|
||||
:end-before: step-3
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-2
|
||||
:end-before: step-3
|
||||
|
||||
@ -251,13 +251,13 @@ You can also get information about available flavors:
|
||||
|
||||
.. only:: fog
|
||||
|
||||
.. literalinclude:: ../../samples/fog/section1.rb
|
||||
.. literalinclude:: ../samples/fog/section1.rb
|
||||
:start-after: step-3
|
||||
:end-before: step-4
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-3
|
||||
:end-before: step-4
|
||||
|
||||
@ -293,13 +293,13 @@ image that you picked in the previous section:
|
||||
|
||||
.. only:: fog
|
||||
|
||||
.. literalinclude:: ../../samples/fog/section1.rb
|
||||
.. literalinclude:: ../samples/fog/section1.rb
|
||||
:start-after: step-4
|
||||
:end-before: step-5
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-4
|
||||
:end-before: step-5
|
||||
|
||||
@ -313,13 +313,13 @@ Next, tell the script which flavor you want to use:
|
||||
|
||||
.. only:: fog
|
||||
|
||||
.. literalinclude:: ../../samples/fog/section1.rb
|
||||
.. literalinclude:: ../samples/fog/section1.rb
|
||||
:start-after: step-5
|
||||
:end-before: step-6
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-5
|
||||
:end-before: step-6
|
||||
|
||||
@ -351,13 +351,13 @@ Create the instance.
|
||||
|
||||
.. only:: fog
|
||||
|
||||
.. literalinclude:: ../../samples/fog/section1.rb
|
||||
.. literalinclude:: ../samples/fog/section1.rb
|
||||
:start-after: step-6
|
||||
:end-before: step-7
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-6
|
||||
:end-before: step-7
|
||||
|
||||
@ -382,13 +382,13 @@ If you list existing instances:
|
||||
|
||||
.. only:: fog
|
||||
|
||||
.. literalinclude:: ../../samples/fog/section1.rb
|
||||
.. literalinclude:: ../samples/fog/section1.rb
|
||||
:start-after: step-7
|
||||
:end-before: step-8
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-7
|
||||
:end-before: step-8
|
||||
|
||||
@ -418,13 +418,13 @@ money. Destroy cloud resources to avoid unexpected expenses.
|
||||
|
||||
.. only:: fog
|
||||
|
||||
.. literalinclude:: ../../samples/fog/section1.rb
|
||||
.. literalinclude:: ../samples/fog/section1.rb
|
||||
:start-after: step-8
|
||||
:end-before: step-9
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-8
|
||||
:end-before: step-9
|
||||
|
||||
@ -467,7 +467,7 @@ instance:
|
||||
In the following example, :code:`pub_key_file` should be set to
|
||||
the location of your public SSH key file.
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-9
|
||||
:end-before: step-10
|
||||
|
||||
@ -481,13 +481,13 @@ instance:
|
||||
|
||||
.. only:: fog
|
||||
|
||||
.. literalinclude:: ../../samples/fog/section1.rb
|
||||
.. literalinclude:: ../samples/fog/section1.rb
|
||||
:start-after: step-10
|
||||
:end-before: step-11
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-10
|
||||
:end-before: step-11
|
||||
|
||||
@ -502,7 +502,7 @@ instance:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-11
|
||||
:end-before: step-12
|
||||
|
||||
@ -520,7 +520,7 @@ request the instance, wait for it to build.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-12
|
||||
:end-before: step-13
|
||||
|
||||
@ -550,7 +550,7 @@ address to your instance.
|
||||
address pool. Allocate this pool to your project and attach it to your
|
||||
instance.
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-13
|
||||
:end-before: step-14
|
||||
|
||||
@ -564,7 +564,7 @@ address to your instance.
|
||||
|
||||
You can then attach it to the instance:
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-14
|
||||
:end-before: step-15
|
||||
|
||||
@ -580,7 +580,7 @@ using your preferred browser.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:start-after: step-15
|
||||
|
||||
.. note:: If you do not use floating IPs, substitute another IP address as appropriate
|
||||
@ -621,5 +621,5 @@ information, the flavor ID, and image ID.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section1.py
|
||||
.. literalinclude:: ../samples/libcloud/section1.py
|
||||
:language: python
|
@ -202,7 +202,7 @@ don't need to execute these commands again.)
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-1
|
||||
:end-before: step-2
|
||||
|
||||
@ -234,7 +234,7 @@ your cloud provider to confirm the user name.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-2
|
||||
:end-before: step-3
|
||||
|
||||
@ -274,7 +274,7 @@ port 22):
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-3
|
||||
:end-before: step-4
|
||||
|
||||
@ -287,7 +287,7 @@ You can list available security groups with:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-4
|
||||
:end-before: step-5
|
||||
|
||||
@ -296,7 +296,7 @@ Once you've created a rule or group, you can also delete it:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-5
|
||||
:end-before: step-6
|
||||
|
||||
@ -305,7 +305,7 @@ To see which security groups apply to an instance, you can:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-6
|
||||
:end-before: step-7
|
||||
|
||||
@ -344,7 +344,7 @@ then associate it to your instance's network interface.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-7
|
||||
:end-before: step-8
|
||||
|
||||
@ -356,7 +356,7 @@ that it has available IP addresses.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-8
|
||||
:end-before: step-9
|
||||
|
||||
@ -364,7 +364,7 @@ Now request that an address from this pool be allocated to your project.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-9
|
||||
:end-before: step-10
|
||||
|
||||
@ -373,7 +373,7 @@ project, attach it to an instance.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-10
|
||||
:end-before: step-11
|
||||
|
||||
@ -412,7 +412,7 @@ Parameter Description Values
|
||||
.. only:: libcloud
|
||||
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-11
|
||||
:end-before: step-12
|
||||
|
||||
@ -427,7 +427,7 @@ Next, start a second instance, which will be the worker instance:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-12
|
||||
:end-before: step-13
|
||||
|
||||
@ -462,7 +462,7 @@ address of the worker:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:start-after: step-13
|
||||
:end-before: step-14
|
||||
|
||||
@ -591,5 +591,5 @@ information, the flavor ID, and image ID.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section2.py
|
||||
.. literalinclude:: ../samples/libcloud/section2.py
|
||||
:language: python
|
@ -157,7 +157,7 @@ are no longer working, remove them and re-create something new.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section3.py
|
||||
.. literalinclude:: ../samples/libcloud/section3.py
|
||||
:start-after: step-1
|
||||
:end-before: step-2
|
||||
|
||||
@ -171,7 +171,7 @@ required security groups.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section3.py
|
||||
.. literalinclude:: ../samples/libcloud/section3.py
|
||||
:start-after: step-2
|
||||
:end-before: step-3
|
||||
|
||||
@ -184,7 +184,7 @@ reaching your Floating IP quota too quickly.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section3.py
|
||||
.. literalinclude:: ../samples/libcloud/section3.py
|
||||
:start-after: step-3
|
||||
:end-before: step-4
|
||||
|
||||
@ -199,7 +199,7 @@ between the services.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section3.py
|
||||
.. literalinclude:: ../samples/libcloud/section3.py
|
||||
:start-after: step-4
|
||||
:end-before: step-5
|
||||
|
||||
@ -216,7 +216,7 @@ multiple API services:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section3.py
|
||||
.. literalinclude:: ../samples/libcloud/section3.py
|
||||
:start-after: step-5
|
||||
:end-before: step-6
|
||||
|
||||
@ -244,7 +244,7 @@ To increase the overall capacity, we will now add 3 workers:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section3.py
|
||||
.. literalinclude:: ../samples/libcloud/section3.py
|
||||
:start-after: step-6
|
||||
:end-before: step-7
|
||||
|
||||
@ -400,5 +400,5 @@ information, the flavor ID, and image ID.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section3.py
|
||||
.. literalinclude:: ../samples/libcloud/section3.py
|
||||
:language: python
|
@ -86,7 +86,7 @@ First, let's learn how to connect to the Object Storage endpoint:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-1
|
||||
:end-before: step-2
|
||||
|
||||
@ -125,7 +125,7 @@ Call yours :code:`fractals`:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-2
|
||||
:end-before: step-3
|
||||
|
||||
@ -140,7 +140,7 @@ all containers in your account:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-3
|
||||
:end-before: step-4
|
||||
|
||||
@ -156,7 +156,7 @@ online, name it :code:`goat.jpg` and upload it to your container
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-4
|
||||
:end-before: step-5
|
||||
|
||||
@ -166,7 +166,7 @@ same:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-5
|
||||
:end-before: step-6
|
||||
|
||||
@ -175,7 +175,7 @@ same:
|
||||
[<Object: name=an amazing goat, size=191874, hash=439884df9c1c15c59d2cf43008180048, provider=OpenStack Swift ...>]
|
||||
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-6
|
||||
:end-before: step-7
|
||||
|
||||
@ -183,7 +183,7 @@ same:
|
||||
|
||||
<Object: name=an amazing goat, size=954465, hash=7513986d3aeb22659079d1bf3dc2468b, provider=OpenStack Swift ...>
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-7
|
||||
:end-before: step-8
|
||||
|
||||
@ -197,7 +197,7 @@ Finally, let's clean up by deleting our test object:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-8
|
||||
:end-before: step-9
|
||||
|
||||
@ -205,7 +205,7 @@ Finally, let's clean up by deleting our test object:
|
||||
|
||||
Now there should be no more objects be available in the container :code:`fractals`.
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-9
|
||||
:end-before: step-10
|
||||
|
||||
@ -224,7 +224,7 @@ Use the :code:`fractals`' container from above to put the images in:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-10
|
||||
:end-before: step-11
|
||||
|
||||
@ -233,7 +233,7 @@ swift container. A simple for loop takes care of that:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-11
|
||||
:end-before: step-12
|
||||
|
||||
@ -267,7 +267,7 @@ the container before running this, otherwise it will fail:
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-12
|
||||
:end-before: step-13
|
||||
|
||||
@ -286,7 +286,7 @@ This is more efficient, especially for larger files.
|
||||
|
||||
.. only:: libcloud
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-13
|
||||
:end-before: step-14
|
||||
|
||||
@ -308,7 +308,7 @@ For efficiency, most Object Storage installations treat large objects
|
||||
:code:`chunk_size` parameter (in bytes) according to what your
|
||||
cloud can accept.
|
||||
|
||||
.. literalinclude:: ../../samples/libcloud/section4.py
|
||||
.. literalinclude:: ../samples/libcloud/section4.py
|
||||
:start-after: step-14
|
||||
:end-before: step-15
|
||||
|
54
tox.ini
54
tox.ini
@ -23,7 +23,7 @@ commands = openstack-doc-test --check-links {posargs}
|
||||
[testenv:checkniceness]
|
||||
commands =
|
||||
openstack-doc-test --check-niceness {posargs}
|
||||
doc8 openstack-firstapp
|
||||
doc8 firstapp
|
||||
|
||||
[testenv:checksyntax]
|
||||
commands =
|
||||
@ -41,12 +41,12 @@ commands =
|
||||
# TODO(ajaeger): We publish to content to allow for reviewing, this needs a
|
||||
# change of openstack-doc-tools to remove content here in the file layout
|
||||
# for previewing.
|
||||
sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build-libcloud/html
|
||||
mkdir -p publish-docs/openstack-firstapp-libcloud/content
|
||||
rsync -a openstack-firstapp/build-libcloud/html/ publish-docs/openstack-firstapp-libcloud/content/
|
||||
sphinx-build -E -W -t fog openstack-firstapp/doc/source openstack-firstapp/build-fog/html
|
||||
mkdir -p publish-docs/openstack-firstapp-fog/content
|
||||
rsync -a openstack-firstapp/build-fog/html/ publish-docs/openstack-firstapp-fog/content/
|
||||
sphinx-build -E -W -t libcloud firstapp/source firstapp/build-libcloud/html
|
||||
mkdir -p publish-docs/firstapp-libcloud/content
|
||||
rsync -a firstapp/build-libcloud/html/ publish-docs/firstapp-libcloud/content/
|
||||
sphinx-build -E -W -t fog firstapp/source firstapp/build-fog/html
|
||||
mkdir -p publish-docs/firstapp-fog/content
|
||||
rsync -a firstapp/build-fog/html/ publish-docs/firstapp-fog/content/
|
||||
# Build DocBook Guides
|
||||
openstack-doc-test --check-build {posargs}
|
||||
|
||||
@ -65,9 +65,9 @@ commands =
|
||||
mv publish-docs/api-ref-guides publish-docs/api-ref/
|
||||
# Build and copy RST Guides as draft
|
||||
# Include only environments that are (partially) written
|
||||
sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build-libcloud/html
|
||||
mkdir -p publish-docs/api-ref/draft/openstack-firstapp-libcloud/
|
||||
rsync -a openstack-firstapp/build-libcloud/html/ publish-docs/api-ref/draft/openstack-firstapp-libcloud/
|
||||
sphinx-build -E -W -t libcloud firstapp/source firstapp/build-libcloud/html
|
||||
mkdir -p publish-docs/api-ref/draft/firstapp-libcloud/
|
||||
rsync -a firstapp/build-libcloud/html/ publish-docs/api-ref/draft/firstapp-libcloud/
|
||||
|
||||
[testenv:checklang]
|
||||
# openstack-generate-docbook needs xml2po which cannot be installed in
|
||||
@ -97,34 +97,34 @@ commands = doc-tools-check-languages doc-tools-check-languages.conf publish all
|
||||
[testenv:docs]
|
||||
commands =
|
||||
# Include only environments that are (partially) written
|
||||
sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build-libcloud/html
|
||||
sphinx-build -E -W -t fog openstack-firstapp/doc/source openstack-firstapp/build-fog/html
|
||||
sphinx-build -E -W -t libcloud firstapp/source firstapp/build-libcloud/html
|
||||
sphinx-build -E -W -t fog firstapp/source firstapp/build-fog/html
|
||||
|
||||
[testenv:openstack-firstapp-libcloud]
|
||||
commands = sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build-libcloud/html
|
||||
[testenv:firstapp-libcloud]
|
||||
commands = sphinx-build -E -W -t libcloud firstapp/source firstapp/build-libcloud/html
|
||||
|
||||
[testenv:openstack-firstapp-jclouds]
|
||||
commands = sphinx-build -E -W -t jclouds openstack-firstapp/doc/source openstack-firstapp/build-jclouds/html
|
||||
[testenv:firstapp-jclouds]
|
||||
commands = sphinx-build -E -W -t jclouds firstapp/source firstapp/build-jclouds/html
|
||||
|
||||
[testenv:openstack-firstapp-fog]
|
||||
commands = sphinx-build -E -W -t fog openstack-firstapp/doc/source openstack-firstapp/build-fog/html
|
||||
[testenv:firstapp-fog]
|
||||
commands = sphinx-build -E -W -t fog firstapp/source firstapp/build-fog/html
|
||||
|
||||
[testenv:openstack-firstapp-dotnet]
|
||||
commands = sphinx-build -E -W -t dotnet openstack-firstapp/doc/source openstack-firstapp/build-dotnet/html
|
||||
[testenv:firstapp-dotnet]
|
||||
commands = sphinx-build -E -W -t dotnet firstapp/source firstapp/build-dotnet/html
|
||||
|
||||
[testenv:openstack-firstapp-node]
|
||||
commands = sphinx-build -E -W -t node openstack-firstapp/doc/source openstack-firstapp/build-node/html
|
||||
[testenv:firstapp-node]
|
||||
commands = sphinx-build -E -W -t node firstapp/source firstapp/build-node/html
|
||||
|
||||
[testenv:openstack-firstapp-openstacksdk]
|
||||
commands = sphinx-build -E -W -t openstacksdk openstack-firstapp/doc/source openstack-firstapp/build-openstacksdk/html
|
||||
[testenv:firstapp-openstacksdk]
|
||||
commands = sphinx-build -E -W -t openstacksdk firstapp/source firstapp/build-openstacksdk/html
|
||||
|
||||
[testenv:openstack-firstapp-todos]
|
||||
commands = sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build/html
|
||||
[testenv:firstapp-todos]
|
||||
commands = sphinx-build -E -W -t libcloud firstapp/source firstapp/build/html
|
||||
|
||||
[doc8]
|
||||
# Settings for doc8:
|
||||
# Ignore target directories
|
||||
ignore-path = openstack-firstapp/build*
|
||||
ignore-path = firstapp/build*
|
||||
# File extensions to use
|
||||
extensions = .rst,.txt
|
||||
# Ignore lines longer than 79 chars
|
||||
|
Loading…
Reference in New Issue
Block a user