Commit Graph

34 Commits

Author SHA1 Message Date
Andreas Jaeger 533fd1ad52 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Set openstackdocs_auto_name to use 'project' as name.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I6430e16e22a2afc0fda3a5a43eccfd3309f20931
2020-05-21 09:22:19 +02:00
Andreas Jaeger fb8bc0b09b [ussuri][goal] Drop python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Cleanup setup.cfg.
Update hacking for python3.
Remove six usage.

Change-Id: I37da6ad3306af138aa16cf73a116f0391d06675f
2020-02-12 08:24:32 +00:00
Frank Kloeker f91deab8fe Switch to translated docs build by openstackdocstheme
Change-Id: Ic10b4bfa469ac11e278bd0ecd8088418d61c4fd5
2018-12-07 07:50:58 +01:00
OpenStack Proposal Bot 9d3a4a3f49 Updated from global requirements
Change-Id: Icec8f1598e651787743c7a9f50b75da8ce740267
2018-03-15 06:59:05 +00:00
OpenStack Proposal Bot c380eb3884 Updated from global requirements
Change-Id: I81b61b6f83fcd26048716d3484aa35f6df3f2444
2018-03-13 06:54:10 +00:00
OpenStack Proposal Bot 0f6d7e25ad Updated from global requirements
Change-Id: Iafe10176b627f1329b3cc32281e67b255f75a095
2018-03-10 13:14:32 +00:00
OpenStack Proposal Bot 603710f2f1 Updated from global requirements
Change-Id: I5d5e6d714be05b90756a07310432971514b48a9b
2018-01-24 00:54:57 +00:00
OpenStack Proposal Bot 3cc96c30e9 Updated from global requirements
Change-Id: If7fc774214d24db70970daf1bbb3939f4a8463c4
2018-01-17 20:34:44 +00:00
OpenStack Proposal Bot 549437dede Updated from global requirements
Change-Id: Icbb255bad365279172c97293acd5261af8226b6c
2017-09-16 23:12:44 +00:00
OpenStack Proposal Bot 36dc717d65 Updated from global requirements
Change-Id: I3f1e679c7e39e07a860dcdd7c0f0620b7f33febb
2017-08-18 04:41:15 +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
OpenStack Proposal Bot 875745e1e4 Updated from global requirements
Change-Id: I31e0e934088f19a89848c593da5bca3790903f7e
2017-07-27 19:10:17 +00:00
Akihiro Motoki 9c13420710 Drop oslosphinx from test-requirements.txt
It is no longer used in the i18n repo.

Change-Id: Id4cfcaefcdfdcdb742f6de8717ce4648a8814b26
2017-07-01 06:36:31 +00:00
OpenStack Proposal Bot 0933b1287a Updated from global requirements
Change-Id: Ibcaa2fa09226ed798a87f0a6a55ce731e33ec83c
2017-06-27 12:10:45 +00:00
Sungjin Knag a5ed752a6f Update document theme
This commit update the document theme. :)

The bug link points to openstack-i18n launchpad project
so that readers can report a bug against openstack-i18n project.

Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: I5356b5d0ba19acc5f6eb86b6e67fd9e5151167da
2017-05-18 07:04:08 +09:00
OpenStack Proposal Bot 098c11381b Updated from global requirements
Change-Id: I1297c21b2a6cb26672aeb573e853a68749af600d
2017-05-17 03:48:28 +00:00
OpenStack Proposal Bot 81e185603a Updated from global requirements
Change-Id: I16c9a4b4123e6f52722d657f86231e94a735855b
2017-04-07 06:05:04 +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
OpenStack Proposal Bot ab391ca2b1 Updated from global requirements
Change-Id: Ifa9aa36d95c808eac7a1ca8a16330990b4f4229e
2017-02-10 05:49:29 +00:00
OpenStack Proposal Bot 1bc7cf57b6 Updated from global requirements
Change-Id: If5268dc60c16ca5a925ba11e9117952c2e212419
2016-09-30 19:59:14 +00:00
OpenStack Proposal Bot e34b6e3cf8 Updated from global requirements
Change-Id: Ie5559ae58a032e592646dc02adaa17f0bc6ddd2c
2016-09-28 16:53:25 +00:00
OpenStack Proposal Bot 09c9ed8636 Updated from global requirements
Change-Id: I674c2ccca306c1fd9f1d6ab788054f9b090842a5
2016-09-27 10:00:09 +00:00
Jenkins ab8f1c7d66 Merge "Syntax check for YAML file" 2016-06-24 04:18:01 +00:00
OpenStack Proposal Bot 192f6f9957 Updated from global requirements
Change-Id: I351531533f7a0a87428bdc3101f19284bd004850
2016-06-21 17:59:39 +00: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
OpenStack Proposal Bot 98aa214e22 Updated from global requirements
Change-Id: Ifce5f6de5c063e848d8b312501cff0570553a669
2016-05-06 22:17:28 +00:00
OpenStack Proposal Bot 14564f8bde Updated from global requirements
Change-Id: I5917333ebfc36a4da5ad131204265f09a1220714
2016-04-13 12:43:17 +00:00
OpenStack Proposal Bot e06c4b33fb Updated from global requirements
Change-Id: I2ae065a3e26ae656693769dd4823d9517c6c95b5
2016-03-28 19:27:24 +00:00
Akihiro Motoki ad0e1bc3a9 update_catalog definition to update glossary
Change-Id: I5163fffa79d5b5e57fab5011f9a5c79c404b9698
2016-03-06 22:53:49 +09:00
OpenStack Proposal Bot 1b36e16725 Updated from global requirements
Change-Id: I1574d3072f096342dff4343e3ef2ee3a3173b523
2016-02-04 18:55:04 +00: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
OpenStack Proposal Bot d12e4ba139 Updated from global requirements
Change-Id: Ibd198f8782a33ebd416eb7571eb0271d6108c6f4
2016-01-16 03:26:56 +00:00
Akihiro Motoki 9e18831b39 Updated from global requirements
The commit is generated by the following command
in requirements repository:

  python update.py ../i18n

The automatic job is now under review in
https://review.openstack.org/256976

Change-Id: I1ff2a375c9b251a218e512687e2c77150634e7cf
2015-12-26 21:01:40 +09: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