9 Commits

Author SHA1 Message Date
Zuul
b291998589 Merge "Update metadata in setup.cfg" 2023-07-20 15:08:50 +00:00
Sairam Vengala
f6220c87e4 Update metadata in setup.cfg
we are using some "aliases" that the setuptools docs say
"are supported for compatibility reasons" but their use is not advised[1].

[1] https://setuptools.pypa.io/en/latest/userguide/declarative_config.html#metadata

please check this below reference link

[2] https://review.opendev.org/c/openstack/charm-cinder/+/854987

Change-Id: I90f8e19da155b6bc7aad400e1d5d3a235034c607
2023-07-12 05:41:07 +00:00
Hiromu Asahina
3779761ee4 Add sphinx plantUML pluging
This patch enables the sphinx PlantUML extension. As PlantUML is often
used in Tacker documents, authors of specs can re-use diagrams when
they write user guides with small revising.

To build plantUML with a sphinx PlantUML extension:
- Updated conf.py
- Updated requirements
- Added plantuml.jar

To use the sphinx PlantUML extension in Zuul jobs:
- Added bindep [1][2] to install graphviz
- Added pre.yaml to install java [3]
- Updated setup.cfg (this is necessary to place more than two
  directories at the project root)

Others:
- Added examples to 2023.2/placeholder.rst and template.rst

[1] https://github.com/openstack/cinder-specs/blob/master/bindep.txt
[2] https://docs.opendev.org/opendev/bindep/latest/readme.html
[3] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-java

Change-Id: I72c2c7887ceba4734b367f7e5bc78921eb0ab0a1
2023-07-09 22:14:44 +09:00
Manpreet Kaur
55cf046a80 setup.cfg: Replace dashes with underscores
Setuptools v54.1.0 introduces a warning that the use of dash-separated
options in 'setup.cfg' will not be supported in a future version [1].
Get ahead of the issue by replacing the dashes with underscores.
Without this, we see 'UserWarning' messages like the following on new
enough versions of setuptools:

  UserWarning: Usage of dash-separated 'description-file' will not be
  supported in future versions. Please use the underscore name
  'description_file' instead

[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb

Change-Id: Iaa9f6083e0c47f437821d317d00e301e8ffe9bdb
2021-05-18 13:16:39 +05:30
Andreas Jaeger
0ec5c69e12 Cleanup py27 support
Make a few cleanups:
- Remove obsolete sections from setup.cfg
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version, update other needed
  requirements
- Remove install_command from tox.ini, the default is fine
- Update tox.ini for python3 support

Change-Id: I0c9f7ae65a8e1c1d7fec77e3958c54324213158b
2020-04-10 11:50:37 +02:00
zhangbailin
c25afa0958 Change openstack-dev to openstack-discuss
Mailinglists have been updated. Openstack-discuss replaces
openstack-dev.

Change-Id: Id91a5cd397eea8fef9fbd77066645202e2d2b83c
2018-12-03 22:13:25 -05:00
Nguyen Hai
d543040a4e Refactor and clean up specs dir
- Follow new PTI building docs
- Add dir for Stein specs
- Remove skeleton.rst file because the template is enough
- Remove archive specs because they are invalid.
- Remove test_tiltles.py because it is useless (no actuall check
the spec files), instead, enable pep8 and waring-as-error for
.rst files, clear error those files.
- Add placeholder.rst for stein/rocky dir, if not they will
show error when building docs, delete them when it has
approved specs.

Change-Id: I8c387c0a480844b111562a9e77eac6ab26c58bce
2018-04-05 15:21:56 +09:00
Nguyen Hai
cb198146a3 Change tacker-specs webpage from oslosphinx to openstackdocstheme
+ Changes tacker-specs webpage from oslosphinx to openstackdocstheme.
+ Clean up some example templates and update links.

Change-Id: I639c86a37e93a16171960f7b20a2538e118e4b97
Closes-Bug: #1754960
2018-03-13 12:41:45 +09:00
Isaku Yamahata
34c3741cf7 Add base tacker-specs framework
Build the base framework for the tacker-specs repository.
This was taken from neutron-specs repository and has been tweaked for
tacker.
2014-06-03 17:55:27 +09:00