Commit Graph

15 Commits

Author SHA1 Message Date
zhangtongjian 8af0629e7e remove unicode from code
Change-Id: I3a30acd10272328462c14bd9a28f95b5f4cb2db0
2021-01-05 17:21:54 +08:00
Andreas Jaeger cdce86efcb 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.

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.

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: If046b8dded45c939bf596fdc8ae95f0d34602054
2020-05-31 19:35:00 +02:00
Andreas Jaeger 63e5a36156 Cleanup py27 support
Make a few cleanups:
- Remove obsolete sections from setup.cfg
- Switch to using sphinx-build
- Cleanup doc/source/conf.py to remove now obsolete content.
- Switch to openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
- Fix docs warnings

Change-Id: Icf6a2d4229392e9d38af67567167b60d02d68019
2020-04-10 11:04:21 +02:00
Ghanshyam Mann 35efbbe802 [ussuri][goal] Drop python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

specs repo either has py27 job or requirement or tox env.

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

Change-Id: Ia6d4378abf5ee92f371236a081b82157a9c88682
2019-12-30 14:45:57 +02:00
Sharat Sharma e4ad2e1a21 Fix doc generation for python 3
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.

Change-Id: I399b769c3d636e40094837764da6a914132a779c
2017-04-17 10:53:53 +00:00
Jenkins 6608923952 Merge "Add Pike specs into index" 2017-03-10 10:33:40 +00:00
Renat Akhmerov c8991a016f Add Pike specs into index
Change-Id: Ia45823a91b4a3f57c713077313ac0e996571a383
2017-03-03 19:09:56 +07:00
Dougal Matthews 3edd778613 Add a policy section to the Mistral specs
The idea of policies is to document something related to the project
that isn't tied to a specific release and often isn't related to code.
For example, a policy could be related to how we organise or how we
agree to do code reviews.

This process is inspired by the policies used in TripleO and the policy
template is a direct copy of the one used in TripleO.

Change-Id: I05f5076a1559790bf6d0f7b68d528748a2acd20b
2017-03-02 11:31:42 +00:00
Sharat Sharma 5f05c9e69d 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: I7b8e5e23bc9dc439bc29fcf791fc44d0c82cb8ab
Closes-Bug: #1552251
2017-01-31 17:25:54 +05:30
Sharat Sharma feaa16a819 Removes unnecessary utf-8 encoding
Change-Id: I5c4c5e5b25d3a4a17c523d96c1c97cd42bfff7f6
2017-01-11 11:11:59 +05:30
Lingxian Kong 20d3fb5e0f Move spec files to correct location
Change-Id: I5e097c6900bb82064b6160476f51b63f243c970d
2016-10-18 16:15:10 +13:00
Jenkins 76a0544c10 Merge "Replace deprecated library function os.popen() with subprocess" 2016-05-25 06:52:09 +00:00
Harshada Mangesh Kakad f6d4422c9b Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: I24714535b3745b21657c97c7acc00a92dbc2cfda
Closes-Bug: #1529836
2016-05-25 05:14:33 +00:00
Lingxian Kong 775b47323a Copy implemented spec files to the implemented folder
Create 'newton' folder for next dev cycle as well.

Change-Id: Ibb25925e991ba273301476096dffc726815c7457
2016-03-01 22:00:49 +13:00
Lingxian Kong 170b47d7ea Initial commit
Add structure, unit tests, and template for mistral-specs, creating
a functional specs repository without any approved specs.

Put example.rst in mitaka/approved and mitaka/implemented respectively
to avoid doc build warnings:
"pattern u'specs/mitaka/approved/*' didn't match any documents"

Implements: blueprint mistral-spec-repository
Change-Id: I092ec2f9b1aef9b1bf328658674119eb3cdf3380
2015-11-18 22:25:55 +08:00