openstack/api-site
Code Issues Proposed changes

FirstApp: Move source directory up, rename top-level dir

Browse Source 
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:
Andreas Jaeger 2015-05-01 11:41:27 +02:00
parent e7040ded4f
commit f58477ef61
28 changed files with 95 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -18,4 +18,4 @@ target/
*~ *~
.*.swp .*.swp
.bak .bak
/openstack-firstapp/build*/ /firstapp/build*/

2
doc-tools-check-languages.conf
View File

@ -33,5 +33,5 @@ DOC_DIR="./"
# Values need to match content in project-config/jenkins/scripts/common_translation_update.sh # Values need to match content in project-config/jenkins/scripts/common_translation_update.sh
declare -A SPECIAL_BOOKS declare -A SPECIAL_BOOKS
SPECIAL_BOOKS=( SPECIAL_BOOKS=(
["openstack-firstapp"]="skip" ["firstapp"]="skip"
) )

8
openstack-firstapp/README.rst → firstapp/README.rst
View File

@ -8,15 +8,15 @@ tutorial.
The tutorials works with an application that can be found at: The tutorials works with an application that can be found at:
https://github.com/stackforge/faafo 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. documentation. It's reStructuredText (RST), built with Sphinx.
The RST source includes conditional output logic, so specifying:: 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 will invoke :code:`sphinx-build` with :code:`-t libcloud`, meaning sections
marked :code:`.. only:: libcloud` in the RST will be built, while others marked :code:`.. only:: libcloud` in the RST will be built, while others

0
openstack-firstapp/samples/fog/section1.rb → firstapp/samples/fog/section1.rb
View File

0
openstack-firstapp/samples/libcloud/section1.py → firstapp/samples/libcloud/section1.py
View File

0
openstack-firstapp/samples/libcloud/section2.py → firstapp/samples/libcloud/section2.py
View File

0
openstack-firstapp/samples/libcloud/section3.py → firstapp/samples/libcloud/section3.py
View File

0
openstack-firstapp/samples/libcloud/section4.py → firstapp/samples/libcloud/section4.py
View File

4
openstack-firstapp/setup.cfg → firstapp/setup.cfg
View File

@ -13,8 +13,8 @@ classifier =
[build_sphinx] [build_sphinx]
all_files = 1 all_files = 1
build-dir = doc/build build-dir = build
source-dir = doc/source source-dir = source
[pbr] [pbr]
warnerrors = True warnerrors = True

0
openstack-firstapp/setup.py → firstapp/setup.py
View File

0
openstack-firstapp/doc/source/appendix.rst → firstapp/source/appendix.rst
View File

0
openstack-firstapp/doc/source/conf.py → firstapp/source/conf.py
View File

0
openstack-firstapp/doc/source/images/architecture.dot → firstapp/source/images/architecture.dot
View File

0
openstack-firstapp/doc/source/images/fractal-example.png → firstapp/source/images/fractal-example.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

0
openstack-firstapp/doc/source/images/network-topology.png → firstapp/source/images/network-topology.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

0
openstack-firstapp/doc/source/images/screenshot_webinterface.png → firstapp/source/images/screenshot_webinterface.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 202 KiB

After

Width:  |  Height:  |  Size: 202 KiB

0
openstack-firstapp/doc/source/images/work_queue.dot → firstapp/source/images/work_queue.dot
View File

0
openstack-firstapp/doc/source/index.rst → firstapp/source/index.rst
View File

50
openstack-firstapp/doc/source/section1.rst → firstapp/source/section1.rst
View File

@ -178,7 +178,7 @@ initial version of the guide assume that you're using Libcloud.
.. only:: fog .. only:: fog
.. literalinclude:: ../../samples/fog/section1.rb .. literalinclude:: ../samples/fog/section1.rb
:start-after: step-1 :start-after: step-1
:end-before: step-2 :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 To try it, add the following code to a Python script (or use an
interactive Python shell) by calling :code:`python -i`. interactive Python shell) by calling :code:`python -i`.
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-1 :start-after: step-1
:end-before: step-2 :end-before: step-2
@ -230,13 +230,13 @@ To list the images that are available in your cloud, run some API calls:
.. only:: fog .. only:: fog
.. literalinclude:: ../../samples/fog/section1.rb .. literalinclude:: ../samples/fog/section1.rb
:start-after: step-2 :start-after: step-2
:end-before: step-3 :end-before: step-3
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-2 :start-after: step-2
:end-before: step-3 :end-before: step-3
@ -251,13 +251,13 @@ You can also get information about available flavors:
.. only:: fog .. only:: fog
.. literalinclude:: ../../samples/fog/section1.rb .. literalinclude:: ../samples/fog/section1.rb
:start-after: step-3 :start-after: step-3
:end-before: step-4 :end-before: step-4
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-3 :start-after: step-3
:end-before: step-4 :end-before: step-4
@ -293,13 +293,13 @@ image that you picked in the previous section:
.. only:: fog .. only:: fog
.. literalinclude:: ../../samples/fog/section1.rb .. literalinclude:: ../samples/fog/section1.rb
:start-after: step-4 :start-after: step-4
:end-before: step-5 :end-before: step-5
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-4 :start-after: step-4
:end-before: step-5 :end-before: step-5
@ -313,13 +313,13 @@ Next, tell the script which flavor you want to use:
.. only:: fog .. only:: fog
.. literalinclude:: ../../samples/fog/section1.rb .. literalinclude:: ../samples/fog/section1.rb
:start-after: step-5 :start-after: step-5
:end-before: step-6 :end-before: step-6
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-5 :start-after: step-5
:end-before: step-6 :end-before: step-6
@ -351,13 +351,13 @@ Create the instance.
.. only:: fog .. only:: fog
.. literalinclude:: ../../samples/fog/section1.rb .. literalinclude:: ../samples/fog/section1.rb
:start-after: step-6 :start-after: step-6
:end-before: step-7 :end-before: step-7
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-6 :start-after: step-6
:end-before: step-7 :end-before: step-7
@ -382,13 +382,13 @@ If you list existing instances:
.. only:: fog .. only:: fog
.. literalinclude:: ../../samples/fog/section1.rb .. literalinclude:: ../samples/fog/section1.rb
:start-after: step-7 :start-after: step-7
:end-before: step-8 :end-before: step-8
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-7 :start-after: step-7
:end-before: step-8 :end-before: step-8
@ -418,13 +418,13 @@ money. Destroy cloud resources to avoid unexpected expenses.
.. only:: fog .. only:: fog
.. literalinclude:: ../../samples/fog/section1.rb .. literalinclude:: ../samples/fog/section1.rb
:start-after: step-8 :start-after: step-8
:end-before: step-9 :end-before: step-9
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-8 :start-after: step-8
:end-before: step-9 :end-before: step-9
@ -467,7 +467,7 @@ instance:
In the following example, :code:`pub_key_file` should be set to In the following example, :code:`pub_key_file` should be set to
the location of your public SSH key file. the location of your public SSH key file.
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-9 :start-after: step-9
:end-before: step-10 :end-before: step-10
@ -481,13 +481,13 @@ instance:
.. only:: fog .. only:: fog
.. literalinclude:: ../../samples/fog/section1.rb .. literalinclude:: ../samples/fog/section1.rb
:start-after: step-10 :start-after: step-10
:end-before: step-11 :end-before: step-11
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-10 :start-after: step-10
:end-before: step-11 :end-before: step-11
@ -502,7 +502,7 @@ instance:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-11 :start-after: step-11
:end-before: step-12 :end-before: step-12
@ -520,7 +520,7 @@ request the instance, wait for it to build.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-12 :start-after: step-12
:end-before: step-13 :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 address pool. Allocate this pool to your project and attach it to your
instance. instance.
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-13 :start-after: step-13
:end-before: step-14 :end-before: step-14
@ -564,7 +564,7 @@ address to your instance.
You can then attach it to the instance: You can then attach it to the instance:
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-14 :start-after: step-14
:end-before: step-15 :end-before: step-15
@ -580,7 +580,7 @@ using your preferred browser.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:start-after: step-15 :start-after: step-15
.. note:: If you do not use floating IPs, substitute another IP address as appropriate .. 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 .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section1.py .. literalinclude:: ../samples/libcloud/section1.py
:language: python :language: python

28
openstack-firstapp/doc/source/section2.rst → firstapp/source/section2.rst
View File

@ -202,7 +202,7 @@ don't need to execute these commands again.)
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-1 :start-after: step-1
:end-before: step-2 :end-before: step-2
@ -234,7 +234,7 @@ your cloud provider to confirm the user name.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-2 :start-after: step-2
:end-before: step-3 :end-before: step-3
@ -274,7 +274,7 @@ port 22):
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-3 :start-after: step-3
:end-before: step-4 :end-before: step-4
@ -287,7 +287,7 @@ You can list available security groups with:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-4 :start-after: step-4
:end-before: step-5 :end-before: step-5
@ -296,7 +296,7 @@ Once you've created a rule or group, you can also delete it:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-5 :start-after: step-5
:end-before: step-6 :end-before: step-6
@ -305,7 +305,7 @@ To see which security groups apply to an instance, you can:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-6 :start-after: step-6
:end-before: step-7 :end-before: step-7
@ -344,7 +344,7 @@ then associate it to your instance's network interface.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-7 :start-after: step-7
:end-before: step-8 :end-before: step-8
@ -356,7 +356,7 @@ that it has available IP addresses.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-8 :start-after: step-8
:end-before: step-9 :end-before: step-9
@ -364,7 +364,7 @@ Now request that an address from this pool be allocated to your project.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-9 :start-after: step-9
:end-before: step-10 :end-before: step-10
@ -373,7 +373,7 @@ project, attach it to an instance.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-10 :start-after: step-10
:end-before: step-11 :end-before: step-11
@ -412,7 +412,7 @@ Parameter Description Values
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-11 :start-after: step-11
:end-before: step-12 :end-before: step-12
@ -427,7 +427,7 @@ Next, start a second instance, which will be the worker instance:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-12 :start-after: step-12
:end-before: step-13 :end-before: step-13
@ -462,7 +462,7 @@ address of the worker:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:start-after: step-13 :start-after: step-13
:end-before: step-14 :end-before: step-14
@ -591,5 +591,5 @@ information, the flavor ID, and image ID.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section2.py .. literalinclude:: ../samples/libcloud/section2.py
:language: python :language: python

14
openstack-firstapp/doc/source/section3.rst → firstapp/source/section3.rst
View File

@ -157,7 +157,7 @@ are no longer working, remove them and re-create something new.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section3.py .. literalinclude:: ../samples/libcloud/section3.py
:start-after: step-1 :start-after: step-1
:end-before: step-2 :end-before: step-2
@ -171,7 +171,7 @@ required security groups.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section3.py .. literalinclude:: ../samples/libcloud/section3.py
:start-after: step-2 :start-after: step-2
:end-before: step-3 :end-before: step-3
@ -184,7 +184,7 @@ reaching your Floating IP quota too quickly.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section3.py .. literalinclude:: ../samples/libcloud/section3.py
:start-after: step-3 :start-after: step-3
:end-before: step-4 :end-before: step-4
@ -199,7 +199,7 @@ between the services.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section3.py .. literalinclude:: ../samples/libcloud/section3.py
:start-after: step-4 :start-after: step-4
:end-before: step-5 :end-before: step-5
@ -216,7 +216,7 @@ multiple API services:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section3.py .. literalinclude:: ../samples/libcloud/section3.py
:start-after: step-5 :start-after: step-5
:end-before: step-6 :end-before: step-6
@ -244,7 +244,7 @@ To increase the overall capacity, we will now add 3 workers:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section3.py .. literalinclude:: ../samples/libcloud/section3.py
:start-after: step-6 :start-after: step-6
:end-before: step-7 :end-before: step-7
@ -400,5 +400,5 @@ information, the flavor ID, and image ID.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section3.py .. literalinclude:: ../samples/libcloud/section3.py
:language: python :language: python

28
openstack-firstapp/doc/source/section4.rst → firstapp/source/section4.rst
View File

@ -86,7 +86,7 @@ First, let's learn how to connect to the Object Storage endpoint:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-1 :start-after: step-1
:end-before: step-2 :end-before: step-2
@ -125,7 +125,7 @@ Call yours :code:`fractals`:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-2 :start-after: step-2
:end-before: step-3 :end-before: step-3
@ -140,7 +140,7 @@ all containers in your account:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-3 :start-after: step-3
:end-before: step-4 :end-before: step-4
@ -156,7 +156,7 @@ online, name it :code:`goat.jpg` and upload it to your container
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-4 :start-after: step-4
:end-before: step-5 :end-before: step-5
@ -166,7 +166,7 @@ same:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-5 :start-after: step-5
:end-before: step-6 :end-before: step-6
@ -175,7 +175,7 @@ same:
[<Object: name=an amazing goat, size=191874, hash=439884df9c1c15c59d2cf43008180048, provider=OpenStack Swift ...>] [<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 :start-after: step-6
:end-before: step-7 :end-before: step-7
@ -183,7 +183,7 @@ same:
<Object: name=an amazing goat, size=954465, hash=7513986d3aeb22659079d1bf3dc2468b, provider=OpenStack Swift ...> <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 :start-after: step-7
:end-before: step-8 :end-before: step-8
@ -197,7 +197,7 @@ Finally, let's clean up by deleting our test object:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-8 :start-after: step-8
:end-before: step-9 :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`. 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 :start-after: step-9
:end-before: step-10 :end-before: step-10
@ -224,7 +224,7 @@ Use the :code:`fractals`' container from above to put the images in:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-10 :start-after: step-10
:end-before: step-11 :end-before: step-11
@ -233,7 +233,7 @@ swift container. A simple for loop takes care of that:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-11 :start-after: step-11
:end-before: step-12 :end-before: step-12
@ -267,7 +267,7 @@ the container before running this, otherwise it will fail:
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-12 :start-after: step-12
:end-before: step-13 :end-before: step-13
@ -286,7 +286,7 @@ This is more efficient, especially for larger files.
.. only:: libcloud .. only:: libcloud
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-13 :start-after: step-13
:end-before: step-14 :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 :code:`chunk_size` parameter (in bytes) according to what your
cloud can accept. cloud can accept.
.. literalinclude:: ../../samples/libcloud/section4.py .. literalinclude:: ../samples/libcloud/section4.py
:start-after: step-14 :start-after: step-14
:end-before: step-15 :end-before: step-15

0
openstack-firstapp/doc/source/section5.rst → firstapp/source/section5.rst
View File

0
openstack-firstapp/doc/source/section6.rst → firstapp/source/section6.rst
View File

0
openstack-firstapp/doc/source/section7.rst → firstapp/source/section7.rst
View File

0
openstack-firstapp/doc/source/section8.rst → firstapp/source/section8.rst
View File

0
openstack-firstapp/doc/source/section9.rst → firstapp/source/section9.rst
View File

54
tox.ini
View File

@ -23,7 +23,7 @@ commands = openstack-doc-test --check-links {posargs}
[testenv:checkniceness] [testenv:checkniceness]
commands = commands =
openstack-doc-test --check-niceness {posargs} openstack-doc-test --check-niceness {posargs}
doc8 openstack-firstapp doc8 firstapp
[testenv:checksyntax] [testenv:checksyntax]
commands = commands =
@ -41,12 +41,12 @@ commands =
# TODO(ajaeger): We publish to content to allow for reviewing, this needs a # 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 # change of openstack-doc-tools to remove content here in the file layout
# for previewing. # for previewing.
sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build-libcloud/html sphinx-build -E -W -t libcloud firstapp/source firstapp/build-libcloud/html
mkdir -p publish-docs/openstack-firstapp-libcloud/content mkdir -p publish-docs/firstapp-libcloud/content
rsync -a openstack-firstapp/build-libcloud/html/ publish-docs/openstack-firstapp-libcloud/content/ rsync -a firstapp/build-libcloud/html/ publish-docs/firstapp-libcloud/content/
sphinx-build -E -W -t fog openstack-firstapp/doc/source openstack-firstapp/build-fog/html sphinx-build -E -W -t fog firstapp/source firstapp/build-fog/html
mkdir -p publish-docs/openstack-firstapp-fog/content mkdir -p publish-docs/firstapp-fog/content
rsync -a openstack-firstapp/build-fog/html/ publish-docs/openstack-firstapp-fog/content/ rsync -a firstapp/build-fog/html/ publish-docs/firstapp-fog/content/
# Build DocBook Guides # Build DocBook Guides
openstack-doc-test --check-build {posargs} openstack-doc-test --check-build {posargs}
@ -65,9 +65,9 @@ commands =
mv publish-docs/api-ref-guides publish-docs/api-ref/ mv publish-docs/api-ref-guides publish-docs/api-ref/
# Build and copy RST Guides as draft # Build and copy RST Guides as draft
# Include only environments that are (partially) written # 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 libcloud firstapp/source firstapp/build-libcloud/html
mkdir -p publish-docs/api-ref/draft/openstack-firstapp-libcloud/ mkdir -p publish-docs/api-ref/draft/firstapp-libcloud/
rsync -a openstack-firstapp/build-libcloud/html/ publish-docs/api-ref/draft/openstack-firstapp-libcloud/ rsync -a firstapp/build-libcloud/html/ publish-docs/api-ref/draft/firstapp-libcloud/
[testenv:checklang] [testenv:checklang]
# openstack-generate-docbook needs xml2po which cannot be installed in # 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] [testenv:docs]
commands = commands =
# Include only environments that are (partially) written # 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 libcloud firstapp/source firstapp/build-libcloud/html
sphinx-build -E -W -t fog openstack-firstapp/doc/source openstack-firstapp/build-fog/html sphinx-build -E -W -t fog firstapp/source firstapp/build-fog/html
[testenv:openstack-firstapp-libcloud] [testenv:firstapp-libcloud]
commands = sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build-libcloud/html commands = sphinx-build -E -W -t libcloud firstapp/source firstapp/build-libcloud/html
[testenv:openstack-firstapp-jclouds] [testenv:firstapp-jclouds]
commands = sphinx-build -E -W -t jclouds openstack-firstapp/doc/source openstack-firstapp/build-jclouds/html commands = sphinx-build -E -W -t jclouds firstapp/source firstapp/build-jclouds/html
[testenv:openstack-firstapp-fog] [testenv:firstapp-fog]
commands = sphinx-build -E -W -t fog openstack-firstapp/doc/source openstack-firstapp/build-fog/html commands = sphinx-build -E -W -t fog firstapp/source firstapp/build-fog/html
[testenv:openstack-firstapp-dotnet] [testenv:firstapp-dotnet]
commands = sphinx-build -E -W -t dotnet openstack-firstapp/doc/source openstack-firstapp/build-dotnet/html commands = sphinx-build -E -W -t dotnet firstapp/source firstapp/build-dotnet/html
[testenv:openstack-firstapp-node] [testenv:firstapp-node]
commands = sphinx-build -E -W -t node openstack-firstapp/doc/source openstack-firstapp/build-node/html commands = sphinx-build -E -W -t node firstapp/source firstapp/build-node/html
[testenv:openstack-firstapp-openstacksdk] [testenv:firstapp-openstacksdk]
commands = sphinx-build -E -W -t openstacksdk openstack-firstapp/doc/source openstack-firstapp/build-openstacksdk/html commands = sphinx-build -E -W -t openstacksdk firstapp/source firstapp/build-openstacksdk/html
[testenv:openstack-firstapp-todos] [testenv:firstapp-todos]
commands = sphinx-build -E -W -t libcloud openstack-firstapp/doc/source openstack-firstapp/build/html commands = sphinx-build -E -W -t libcloud firstapp/source firstapp/build/html
[doc8] [doc8]
# Settings for doc8: # Settings for doc8:
# Ignore target directories # Ignore target directories
ignore-path = openstack-firstapp/build* ignore-path = firstapp/build*
# File extensions to use # File extensions to use
extensions = .rst,.txt extensions = .rst,.txt
# Ignore lines longer than 79 chars # Ignore lines longer than 79 chars