Commit Graph

21 Commits

Author SHA1 Message Date
Ghanshyam Mann c3dd963967 [community goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38539
Change-Id: Ic9638150b18710abe263e3bc90b620f11aab8c14
2021-05-31 20:35:38 +00:00
Andreas Jaeger fc9b08fc6e 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.

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.

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: I4fe9ea8ee88dad673849cbb9e1a469ca12705740
2020-05-22 17:23:41 +00:00
zhurong 85abf25358 Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove obsolete sections from setup.cfg
- Remove babel.cfg, this is not needed here at all
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build
- Use newer openstackdocstheme and Sphinx versions
- Remove install_command from tox.ini, the default is fine
- Use TOX_CONSTRAINTS_FILE, UPPER_CONSTRAINTS_FILE is obsolete

Change-Id: I57d447e034c088c83fdd5fb8854dbd9826a200a8
2020-05-11 11:06:58 +08:00
Andreas Jaeger 59d867d409 Cleanup py27 support
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 obsolete sections from setup.cfg:
  * Wheel is not needed for python 3 only repo
  * Some other sections are obsolete
- Update classifiers
- Update requirements, no need for python_version anymore

Change-Id: I49f919ee7d8a23d4958328966a2b633a12bb7525
2020-04-04 17:03:55 +02:00
Ghanshyam Mann 482a66018f [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

python-muranoclient is ready with python 3 and ok to drop the
python 2.7 support.

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

Change-Id: I88134b5253cdf2f30cd004d77b2a40aa6764b77f
2019-12-15 00:40:36 +00:00
Zuul 2f501776a6 Merge "Bump the openstackdocstheme extension to 1.20" 2019-07-04 12:26:44 +00:00
pengyuesheng b3f4d15e14 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: If2ca7919c0a4a488b2719e4063a2c700f23d3e59
2019-07-04 16:20:40 +08:00
pengyuesheng 8ff63983f2 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details
Depend-On: https://review.opendev.org/#/c/663060/

Change-Id: I8751db5a1446be78b07608d39fb9c741bae78fde
2019-07-04 16:16:46 +08:00
zhurong 931bb12420 Fix sphinx requirements
Change-Id: Ia2e50bbdb2d060c9b60fcc0ffa8f5247b6d4e887
2019-05-28 19:42:06 +08:00
malei c742bfa73b Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Co-Authored-By: Nguyen Hai <nguyentrihai93@gmail.com>
Change-Id: Icc5ea5aeafaa517f910620c75f9d401e4fd06b05
2018-04-13 23:25:38 +09:00
zhurong db490d17a5 Using the latest openstackdocstheme settings
Change-Id: If922a2455bd4f6a8fd9fa81d3f9dfaccb8cf845a
2017-07-04 10:30:58 +08:00
zhurong 0838186bab import content from cli-reference in openstack-manuals
Change-Id: Icb3d101f15f28ab5e0e17eb4357889be598acea1
2017-06-27 13:33:41 +08:00
zhurong 4c439e05c2 move existing content into the new standard structure
This patch rearranges and reformats existing content.

Change-Id: I8cac6f099a29c27cea7847547307c039c44f6633
2017-06-27 13:30:39 +08:00
Jenkins b2f1a59b96 Merge "switch to openstackdocstheme" 2017-06-26 16:20:09 +00:00
zhurong f6f814b504 Turn on warning-is-error in sphinx build
Turn on the flag to ensure that future warnings in the doc build
trigger a build failure.

Change-Id: Ic5564ad1ff1b0747f0e45d225c61ac9be4ddce5f
2017-06-26 09:28:45 +08:00
zhurong e98ad87c78 switch to openstackdocstheme
Change-Id: I6e019f7efe7c8bc5680b41e6e09a9ef9174f0a05
2017-06-24 10:15:45 +08:00
pawnesh.kumar dcdc2cbd48 Fix OpenStack Licensing
[H102 H103] Contributed Source code should be licensed under the
Apache 2.0 license.

Change-Id: I3b5920908db7b52dc838a1606b4a214a06e14322
2016-10-07 23:49:01 +05:30
Andreas Jaeger 8b394ff242 Remove unused pngmath Sphinx extension
There's no RST file that uses ".. math" and thus
the pngmath Sphinx extension is not used and can
get removed.

Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
2016-02-29 19:57:31 +01:00
zhu.rong 446d15e392 Update the python-muranoclient docs
1.update the wrap
2.add `:option:` `:command:`

Change-Id: I755cbea17c04452710218d850a2d55765808cb8d
2015-09-25 15:35:24 +08:00
Stan Lagun b66194bacf KEERO-320 - Fix all occurrences of old names (keero, glazier) in python client 2013-04-26 02:00:15 +04:00
Serg Melikyan cc63d38386 Removed all projects except Glazier Api Client 2013-04-09 13:44:21 +04:00