7 Commits

Author SHA1 Message Date
Manpreet Kaur
28cf5645e2 Dropping explicit unicode literal
In python 3, all strings are considered as unicode string.

This patch drops the explicit unicode literal (u'...')
or (u"..") appearances from the unicode strings.

Note: The scope of the patch is to drop unicode literal prefix
from python source code files, documentation and comment are overlook.

Change-Id: I66389d3f4b236a50bd3f193d4e67c2ac10e6ca24
2021-02-02 06:45:53 +05:30
Andreas Jaeger
02d86ba40f Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 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.

Disable openstackdocs_auto_name to use 'project' variable as name.

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.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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.

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

Change-Id: I785707fd8bc6608285c97ff273152db52a11079d
2020-06-01 16:08:52 +02:00
Andreas Jaeger
98a67d5b96 Cleanup Python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove section from setup.cfg: Wheel is not needed for python
  3 only repo
- Remove ancient sections from setup.cfg
- Update requirements
- Update api-ref/source/conf.py for current openstackdocstheme
- Don't test for broken po files, this is done in the infra scripts
  since a long time
- Change shebang lines to use python3

Change-Id: If5276a47b8822c5c19d045fbc5c41394f4a9dd2d
2020-03-29 20:23:26 +00:00
pengyuesheng
301c2eb497 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: Iae2061c63ba1eee98d979a22daf04756c485192b
2019-08-02 16:18:21 +08:00
rajat29
4eb91c8fd7 Fix doc generation for Python3
Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Closes-Bug:#1693670
Change-Id: I90aad6b604084c93e493fbb20acff2321104fdea
2017-05-26 03:58:21 +00:00
soumiyajit
e01be4f9d8 Removed utf-8 encoding
py35 automatically recognizes utf-8 string. Therefore there is no
need to specify it in the header.

Change-Id: I2a5447685b5cd13eba761c100cfb95be99fbc9d4
Closes-Bug: #1671495
2017-03-09 20:08:07 +05:30
Sridhar Ramaswamy
dcd5e78ec4 Initial api-ref skeleton for Tacker
This patch is the first step to bring the NFV Orchestration
API Reference to the repository.
It is a part of the effort described here [1]:

[1] https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan

Once this skeleton patch is merged, an api-ref job can be added to
the gate. The gate job makes it much easier to review API Reference
contents, which will be brought by follow-on patches.

Change-Id: I7cc587f2c7b3c546be9cd11bad7e3b4eeacad171
Co-Authored-By: Naoya Harada <n-harada@vx.jp.nec.com>
2016-11-15 16:25:00 +09:00