delta/openstack/python-swiftclient.git/doc, branch stable/zed

Remove coding comments

2022-03-21T18:29:25+00:00

Everything is unicode in Python 3.

Signed-off-by: Stephen Finucane 
Change-Id: I6a076dc67c461f265ed99878e3959e1992a88189

remove unicode from code

2021-01-03T08:44:32+00:00

Change-Id: I791cc993aef832b30c08fdb5bdd7165a074d263f

Switch to newer openstackdocstheme and reno versions

2020-09-18T19:22:01+00:00

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.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

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: I4418f86c3066353d43758118865baf66d1741c79

Clean up some requirements

2020-09-18T19:22:01+00:00

* Drop the py26 marker for futures; we don't support 2.6 anymore.
* Split hacking version used based on python version.
* Clean up sphinx split -- 2.0+ aren't available to install on py2,
  anyway.

Depends-On: https://review.opendev.org/#/c/752340/
Depends-On: https://review.opendev.org/#/c/752736/
Change-Id: I5a6ba8e65c23ada7297f6684dcbdd886591d0af5

Merge "Ussuri contrib docs community goal"

2020-06-01T23:33:33+00:00

Fix pygments style

2020-05-20T07:27:49+00:00

New theme of docs (Victoria+) respects pygments_style.
Since we starts using Victoria reqs while being on Ussuri,
this patch ensures proper rendering both in Ussuri and Victoria.

Change-Id: Iad418798277b9d7a1190e42e9079080a3d2707f3

Ussuri contrib docs community goal

2020-05-13T05:36:22+00:00

This patch standardizes the CONTRIBUTING.rst file and adds the
required doc/source/contributor/contributing.rst

The contibuting.txt points to the Swift contributor documentation.

Change-Id: Ia6c105698dd0269479536645270d12a7c1061bc7

Update docs building

2020-04-19T07:57:27+00:00

Update docs building:
* Switch to sphinx-build
* Update requirements for Sphinx and openstackdocstheme for
  python 3
* Remove unneeded doc and translation sections from setup.cfg
* Remove install_command, it's unneeded, the default is fine.

Change-Id: Ib9fe754b700bceb164ba0f596cbcc6d864ccbadc

PDF Documentation Build tox target

2019-09-04T18:29:37+00:00

This patch adds a `pdf-docs` tox target that will build
PDF versions of our docs. As per the Train community goal:

  https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Story: 2006122
Task: 35514
Change-Id: I7e0ee410ac603774e4b03f859ac3aa20e5afc9b8

Merge "Add missing value in command line docs"

2019-07-09T22:57:56+00:00