21 Commits

Author SHA1 Message Date
Andreas Jaeger
f6f2699c78 Cleanup running jobs
With the changed PTI doc building, this repo can now use the standard
way of building docs, use publish-openstack-docs-pti template and remove
custom jobs.

Since this repo is not co-installed, it does not need requirements and
lower-constraints - like none of the documentation projects. Remove
these.

Remove also lower-constraints tox environment and unused pip install
command from tox.ini as the default is just fine.

Remove passenv from docs environment, this is not needed with current CI
jobs anymore.

Change-Id: I52544b825d3de626f25a81acdb0f62e73771051a
2018-12-07 08:49:55 +01:00
Frank Kloeker
f91deab8fe Switch to translated docs build by openstackdocstheme
Change-Id: Ic10b4bfa469ac11e278bd0ecd8088418d61c4fd5
2018-12-07 07:50:58 +01:00
Frank Kloeker
cd44236152 move tox jobs and I18n tools to Python3
Change-Id: I53f840e6c5e5d6656255c76f14fb5b5bf08e57f3
2018-09-11 22:31:33 +02:00
Akihiro Motoki
1e1a033c8e doc: avoid RST files in subdirectory
We are discussing an approach on translation support in
project documents in https://review.openstack.org/#/c/543220/.
In this approach POT files for RST files in subdirectory are
treated differently. In the i18n doc, atc-stats directory is
the only exception and the thing would be much simpler if it
is moved to a top directory.

tools/generatepot.sh is updated accordingly.

Also generatepot.sh is added to pep8 tox env to confirm
generatepot.sh works successfully.

Change-Id: Ia227358cf9681e8d1745f4c260fe9c97ab18a3e7
2018-04-18 11:22:09 +09:00
Zuul
b8f79b5784 Merge "add lower-constraints job" 2018-03-27 16:20:44 +00:00
Frank Kloeker
7500ab0805 Ansible playbook to generate I18n Extra-ATCs
Change-Id: Idbfadc365f9bf0e3dcf3b03b51b0862dafefa7e9
2018-03-25 14:22:27 +00:00
Doug Hellmann
534ffc9a17 add lower-constraints job
Create a tox environment for running the unit tests against the lower
bounds of the dependencies.

Create a lower-constraints.txt to be used to enforce the lower bounds
in those tests.

Add openstack-tox-lower-constraints job to the zuul configuration.

See http://lists.openstack.org/pipermail/openstack-dev/2018-March/128352.html
for more details.

Change-Id: I2115c1c13e609c3f720c44f38f5562cead456373
Depends-On: https://review.openstack.org/555034
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-03-22 13:41:48 -04:00
Monty Taylor
fab85312b0
Add special docs build job
The new PTI doesn't work for the way the i18n docs are built. Add a new
doc build job that runs tox -edocs for until we figure out a better path
to success.

Remove the add-marker code since that's done in the doc publication
jobs. Also stop rsyncing the code to a different directory, since it'll
make the normal build case wrong and is otherwise handled by the
publication jobs.

Change-Id: I5237e750b4bc4899d71952a14c8d2ca92d9985a0
2017-12-05 14:50:03 -06:00
ChJR
e05d6d58a9 Fixes tox pep8 error in macOS
Let's remove xargs GNU Extended option -r, --no-run-if-empty in tox.ini.

Change-Id: Ia014da76d51fa538513702560cd86da2bb1ae958
2017-08-21 09:03:31 +00:00
Ian Y. Choi
572fcb052c Uses doc8 check
doc8 is a linter for documents and used in Docs team.
Let's enforce the linter for better writing of I18n contributor guide.

(The rules are the same in I3810df521068ffc97e25a5fc56b72397bf9783bc)

Change-Id: Ib7662e6ea8095b371074e6404dbb179e89a00a94
2017-08-04 17:17:29 +00:00
Akihiro Motoki
c1dc203aba Add a check if a proposed team member list is current
It is a boring job to review a patch to update the team member list.
To avoid this, this commit proposes a bit improved approach.

- When you want to propose an update of the team member list,
  you need to sync all members with Zanata.
  If you want to add you, you need to propose a latest member list.
  The new list may contains someone other than you.
- pep8 job checks a proposed member list is up-to-date.
  If not, the job fails.

To make it easy to sync all members with Zanata, a tox target
'zanata-users-sync' is added. To download the latest member list
of all language teams, just run:

  tox -e zanata-users-sync

Change-Id: I393a6b77261f6a3d7788a4c4f57bd6fdc95b5146
2017-07-31 15:19:43 +00:00
Akihiro Motoki
7225d59f2a Move doc location to the new structure
During the doc migration spec, the location of published document
is changed to /<project>/latest. The i18n guide is now published
in their own way, so we need to switch the new location manually.

Change-Id: I2d4c885810a60db19af6fdf93d1ee8d7a8f81142
2017-07-01 07:43:32 +00:00
Ian Y. Choi
412dfb045e Publish translated guides with publishdocs tox job
This patch proposes to publish translated I18n contributor guide(s)
using publishdocs tox job.

It assumes that the URL structure of translated guides would follow
https://docs.openstack.org/developer/i18n/[language-code] scheme.

publishdocs tox job first executes docs job
which builds the original guide, then it executes build-docs.sh
build-docs.sh shell script which outputs
translated I18n contributor guide(s) into [language-code] directory
from current docs job output directory.
Then it copies to publish-docs/developer/i18n directory including
translated guide(s). The directory will be synced through
infra jenkins job which is implemented later.

Note that specifying locale directory in conf.py is needed
to enable sphinx-build execution with locale files.

Implements: blueprint i18n-guide-translation
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: Id117308190de56bf9a9c4eb712bda82dea6f9e51
2017-06-23 20:37:33 +09:00
Akihiro Motoki
9863413692 Remove Python 2 dependency from docs build
Change-Id: I0b7676caa3ef836d03d9620ae55bea1fdda72d6a
2017-05-19 23:48:10 +09:00
Ian Y. Choi
920a44ce81 Adds generate pot script
This commit adds a tox job to generate a pot file
from I18n Contributor Guide.

Change-Id: I0ffecc0767237bffe075c279d88a9f20ffd190d4
Implements: blueprint i18n-guide-translation
2017-04-24 15:03:45 +00:00
Akihiro Motoki
3e8b02e423 Add requirements.txt
It is nice to list packages required to run tools in the i18n repo
in requirements.txt.

Change-Id: Idcf10b551a1e08a98df13594124bc1b63e3987db
2017-03-07 11:36:08 +00:00
Tony Breeds
2f6730fc11 Add Constraints support
To be co-installable with other OpenStack projects and have consistent
testing it's a good idea (tm) to use constraints when creating tox
environments.

Change-Id: I776ac1ae0ef5067bc9679cad97a643ec8f852eb9
2016-12-21 11:15:42 +11:00
Akihiro Motoki
e82f33d220 Syntax check for YAML file
translation_team.yaml is now used by stackalytics.
It is a good idea to YAML format check in pep8 check.

Change-Id: I33f6311412a5cb67692992e1ba021d56eede7ce5
2016-06-16 02:19:18 +09:00
Akihiro Motoki
24a4a22b54 Add PO/POT format check to pep8
Also cleans up unnecessary contents in tox.ini.

Change-Id: I8f630f32286fa6c2d3ab58e07d135f8e26b3c36d
2016-02-27 23:44:15 +09:00
Akihiro Motoki
639f653d71 Enable pep8 tox env
Fix a long line in doc/source/conf.py
Add *.egg-info which is created when virtualenv is setup

Change-Id: I3fb00e744b2d192870b5d1ea192a6091f7f0a7d8
2016-02-03 07:51:20 +00:00
KATO
1c6b5ab0e4 Set up the initial documentation infra
This commit adds tox.ini and define test targets.
Naming of tox targets follows OpenStack most projects:
- docs for document generation

For mainly a testing purpose, contributor-guide/source/index.rst
includes CONTRIBUTING.rst at the top level.
To generate the current doc, run "tox -e docs".

setup.py and setup.cfg are added because they are
required to publish the docs to docs.o.o.

Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Implements: blueprint i18n-contributor-guide
Change-Id: Iaf3b09865ced8b30f987b68a07c2970d2b425708
2015-11-09 20:23:19 +09:00