<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/openstack/python-cinderclient.git/doc/source/conf.py, branch stable/zed</title>
<subtitle>opendev.org: openstack/python-cinderclient.git
</subtitle>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/'/>
<entry>
<title>Dropping explicit unicode literal</title>
<updated>2021-03-11T13:32:54+00:00</updated>
<author>
<name>tushargite96</name>
<email>tushargite96@gmail.com</email>
</author>
<published>2021-02-16T14:25:30+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/commit/?id=d9213138b1df8ead680823157848b8f5056b9c63'/>
<id>d9213138b1df8ead680823157848b8f5056b9c63</id>
<content type='text'>
In python 3, all strings are considered as unicode string.

This patch drops the explicit unicode literal (u'...')
or (u"..") appearances from the unicode strings.

Change-Id: I9902966892a1dc4f85d449dfe580fb128647487b
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
In python 3, all strings are considered as unicode string.

This patch drops the explicit unicode literal (u'...')
or (u"..") appearances from the unicode strings.

Change-Id: I9902966892a1dc4f85d449dfe580fb128647487b
</pre>
</div>
</content>
</entry>
<entry>
<title>Add directive to document CLI</title>
<updated>2020-06-04T03:19:10+00:00</updated>
<author>
<name>Sean McGinnis</name>
<email>sean.mcginnis@gmail.com</email>
</author>
<published>2020-06-04T02:19:59+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/commit/?id=1021aee31f5c0df9e02f71f9827797dacd568e24'/>
<id>1021aee31f5c0df9e02f71f9827797dacd568e24</id>
<content type='text'>
Our CLI docs are very out of date. These used to be generated by the
docs team with some tooling they had. Since the docs moved in-repo, that
tooling has gone away, and for the most part no one has done any updates
to the CLI docs.

This adds a sphinx directive that will generate these docs every time
the docs are built. This way, whenever someone makes a CLI change, they
do not need to have to know to also edit a documentation file to match
their change. Any code changes will automatically be picked up and
reflected in the docs.

Change-Id: I4406872ab6e9335e338b710e492171580df74fa5
Signed-off-by: Sean McGinnis &lt;sean.mcginnis@gmail.com&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Our CLI docs are very out of date. These used to be generated by the
docs team with some tooling they had. Since the docs moved in-repo, that
tooling has gone away, and for the most part no one has done any updates
to the CLI docs.

This adds a sphinx directive that will generate these docs every time
the docs are built. This way, whenever someone makes a CLI change, they
do not need to have to know to also edit a documentation file to match
their change. Any code changes will automatically be picked up and
reflected in the docs.

Change-Id: I4406872ab6e9335e338b710e492171580df74fa5
Signed-off-by: Sean McGinnis &lt;sean.mcginnis@gmail.com&gt;
</pre>
</div>
</content>
</entry>
<entry>
<title>Switch to newer openstackdocstheme and reno versions</title>
<updated>2020-05-22T17:25:19+00:00</updated>
<author>
<name>Andreas Jaeger</name>
<email>aj@suse.com</email>
</author>
<published>2020-05-15T18:12:15+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/commit/?id=1a81faf86a7cc644c761dcf43ed19e6c2db0033d'/>
<id>1a81faf86a7cc644c761dcf43ed19e6c2db0033d</id>
<content type='text'>
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.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_auto_name to use project as name.

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.

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: I2cc022495b162bec1424ec69611acb879900c005
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_auto_name to use project as name.

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.

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: I2cc022495b162bec1424ec69611acb879900c005
</pre>
</div>
</content>
</entry>
<entry>
<title>Fix doc bug filing link</title>
<updated>2020-03-06T16:47:24+00:00</updated>
<author>
<name>Eric Harney</name>
<email>eharney@redhat.com</email>
</author>
<published>2020-03-06T16:41:21+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/commit/?id=5fe5c63b510ad6741b98581eb7faa82f1354e549'/>
<id>5fe5c63b510ad6741b98581eb7faa82f1354e549</id>
<content type='text'>
This needs to go to "python-cinderclient"
to work instead of "cinderclient".

Add a "doc" tag to these bugs as well.

Change-Id: I45ae03e9c071dd9b159b1c0183b53db4dd837453
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
This needs to go to "python-cinderclient"
to work instead of "cinderclient".

Add a "doc" tag to these bugs as well.

Change-Id: I45ae03e9c071dd9b159b1c0183b53db4dd837453
</pre>
</div>
</content>
</entry>
<entry>
<title>Change PDF file name</title>
<updated>2019-09-04T04:53:40+00:00</updated>
<author>
<name>Andreas Jaeger</name>
<email>aj@suse.com</email>
</author>
<published>2019-09-04T04:53:40+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/commit/?id=6f761f6bf0764e4b42a56dbd73c24adf6be038e2'/>
<id>6f761f6bf0764e4b42a56dbd73c24adf6be038e2</id>
<content type='text'>
The previously choosen PDF file name conflicts in some repos with the
project logos (badge). Thus change https://review.opendev.org/679777
renames the desired PDF name to be doc-PROJECT.pdf to allow using the
badge in PDF files.

Follow this rename.

Change-Id: Ife8461f00ba2206d18ae45837bbc31d211e29841
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
The previously choosen PDF file name conflicts in some repos with the
project logos (badge). Thus change https://review.opendev.org/679777
renames the desired PDF name to be doc-PROJECT.pdf to allow using the
badge in PDF files.

Follow this rename.

Change-Id: Ife8461f00ba2206d18ae45837bbc31d211e29841
</pre>
</div>
</content>
</entry>
<entry>
<title>Add support for building pdf documentation</title>
<updated>2019-08-27T01:49:02+00:00</updated>
<author>
<name>Walter A. Boring IV</name>
<email>waboring@hemna.com</email>
</author>
<published>2019-08-20T20:20:38+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/commit/?id=4c031b92948553a00c1fc32e0c355a88efaffb3c'/>
<id>4c031b92948553a00c1fc32e0c355a88efaffb3c</id>
<content type='text'>
This patch updates tox.ini to build the pdf version of
cinderclient documentation.

run tox -epdf-docs

Change-Id: If1f43e593db6ff6740b8a88b517c4505e39a3edd
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
This patch updates tox.ini to build the pdf version of
cinderclient documentation.

run tox -epdf-docs

Change-Id: If1f43e593db6ff6740b8a88b517c4505e39a3edd
</pre>
</div>
</content>
</entry>
<entry>
<title>Bump openstackdocstheme to 1.20.0</title>
<updated>2019-07-04T05:53:20+00:00</updated>
<author>
<name>翟小君</name>
<email>zhaixiaojun@gohighsec.com</email>
</author>
<published>2019-06-06T02:22:32+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/commit/?id=95a469f9865264dba5d0e19dd29f034960100f62'/>
<id>95a469f9865264dba5d0e19dd29f034960100f62</id>
<content type='text'>
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: Icbfa21da1e83f745a98822a2f33c4ebc8d11fd0c
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: Icbfa21da1e83f745a98822a2f33c4ebc8d11fd0c
</pre>
</div>
</content>
</entry>
<entry>
<title>Fix doc build error</title>
<updated>2018-12-14T16:43:56+00:00</updated>
<author>
<name>Eric Harney</name>
<email>eharney@redhat.com</email>
</author>
<published>2018-10-18T20:00:30+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/commit/?id=2505e2a9031f13fbcb1f639ee5f21a2a30f77715'/>
<id>2505e2a9031f13fbcb1f639ee5f21a2a30f77715</id>
<content type='text'>
Doc build keeps failing w/

Recursion error:
    maximum recursion depth exceeded while pickling an object

Sphinx recommends bumping up the recursion limit to
get around this, and it appears to work.

Change-Id: If0a78f9af2e4ddd5fd88c44757642355b3a5bf2e
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Doc build keeps failing w/

Recursion error:
    maximum recursion depth exceeded while pickling an object

Sphinx recommends bumping up the recursion limit to
get around this, and it appears to work.

Change-Id: If0a78f9af2e4ddd5fd88c44757642355b3a5bf2e
</pre>
</div>
</content>
</entry>
<entry>
<title>doc: Remove cruft from conf.py</title>
<updated>2017-08-22T10:44:35+00:00</updated>
<author>
<name>Stephen Finucane</name>
<email>sfinucan@redhat.com</email>
</author>
<published>2017-04-19T09:01:33+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/commit/?id=bda535e15d724579b54607168549666090572ec3'/>
<id>bda535e15d724579b54607168549666090572ec3</id>
<content type='text'>
Change-Id: I0c0c77c25d3c96dd3c6a2a01be4f196c02e71dd6
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Change-Id: I0c0c77c25d3c96dd3c6a2a01be4f196c02e71dd6
</pre>
</div>
</content>
</entry>
<entry>
<title>Use Sphinx 1.5 warning-is-error</title>
<updated>2017-08-22T10:41:50+00:00</updated>
<author>
<name>Stephen Finucane</name>
<email>sfinucan@redhat.com</email>
</author>
<published>2017-08-22T10:41:50+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/openstack/python-cinderclient.git/commit/?id=5d0b4bdc6e62c680dffb8aae8a1d95b869f89220'/>
<id>5d0b4bdc6e62c680dffb8aae8a1d95b869f89220</id>
<content type='text'>
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate the
setting from the old warnerrors one.

Change-Id: Ifd411ead74497a43ab22c57090ece2e1c7cfddb5
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate the
setting from the old warnerrors one.

Change-Id: Ifd411ead74497a43ab22c57090ece2e1c7cfddb5
</pre>
</div>
</content>
</entry>
</feed>
