Commit Graph

11 Commits

Author SHA1 Message Date
Hervé Beraud 1d3e05a6e8 Stop to use the __future__ module.
The __future__ module [1] was used in this context to ensure compatibility
between python 2 and python 3.

We previously dropped the support of python 2.7 [2] and now we only support
python 3 so we don't need to continue to use this module and the imports
listed below.

Imports commonly used and their related PEPs:
- `division` is related to PEP 238 [3]
- `print_function` is related to PEP 3105 [4]
- `unicode_literals` is related to PEP 3112 [5]
- `with_statement` is related to PEP 343 [6]
- `absolute_import` is related to PEP 328 [7]

[1] https://docs.python.org/3/library/__future__.html
[2] https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html
[3] https://www.python.org/dev/peps/pep-0238
[4] https://www.python.org/dev/peps/pep-3105
[5] https://www.python.org/dev/peps/pep-3112
[6] https://www.python.org/dev/peps/pep-0343
[7] https://www.python.org/dev/peps/pep-0328

Change-Id: I3a0de577d7fc75eb83c143fcf595e01eca676446
2020-06-02 20:12:23 +02:00
Andreas Jaeger 69f4b79813 Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

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: I10e31a8883739e8844b9d974cf4da62cfc28efe0
2020-05-30 16:44:50 +02:00
Andreas Jaeger 2bf5e4c0b3 Cleanup docs building
* Switch to newer openstackdocstheme version and remove values that are
  set now by openstackdocstheme.
* Remove py2 requirments for docs, we only build with python3.
* Update deps for docs building, we don't need the default.
* Remove modindex, this is not build, see
  https://docs.openstack.org/ec2-api/latest/py-modindex.html

Change-Id: I6958cbed944de0a1eea02de10c5a4916b6a7293d
2020-02-23 14:18:20 +01:00
Zuul ee5a7ee09e Merge "rework tox.ini" 2017-10-20 15:19:16 +00:00
tikitavi 0445156611 rework tox.ini
separate works for py27, py35
add docs test
some other changes to let tests pass

Change-Id: I94291a5e65fee1e266fbe4e2ec3e14f042654598
2017-10-20 12:16:30 +03:00
tikitavi 41309f5922 update of Installation Guide
added sections Manual Installation and Installation on DevStack

Change-Id: I206ae2e5fdd13a4cac700189d388578777b589c6
2017-10-16 15:54:29 +03:00
tikitavi 9e91db17aa Add configuration reference to doc/source/configuration
Change-Id: I077f4e7c3b12689f809cd68177e00a097d6cd0a2
2017-09-28 16:55:10 +03:00
Vu Cong Tuan 5f1377bb94 Fix html_last_updated_fmt for Python3
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: I39e3cc70f51f9ebb2973ea5a7e6cb12d3b19d6cb
Closes-Bug:#1693670
2017-06-04 12:27:00 +07:00
Thomas Bechtold 5024a8cb78 Fix doc build if git is absent
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.

Change-Id: I2c219d64e33ab8af7e883e6153855d040d8f8f38
Closes-Bug: #1552251
2016-04-13 09:51:11 +02:00
Harshada Mangesh Kakad 095cb42e44 Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: Iff4999077b46b84054a6c7c5d1c8b7b28428f24d
Closes-Bug: #1529836
2016-01-14 06:33:00 -08:00
Andrey Pavlov 87ea3a4bac add template for documentation
Change-Id: I3674443191a2cf4f49d18a3dc521765c3e778737
2015-04-15 18:09:33 +03:00