11 Commits

Author SHA1 Message Date
Stephen Finucane
4fc0a51a17 doc: Restructure docs for doc-migration
We have three populated sections:

- install
- user
- reference

There are three docs removed, as they served little useful purpose and
were mostly unreferenced.

Sphinx's 'warning-is-error' option is enabled to catch the few issues
that has snuck into the docs.

Change-Id: I04e426faf337f0b03175f439c80b3369d4066733
2017-08-08 15:44:29 +01:00
Stephen Finucane
f3eb28dcf6 doc: Remove cruft from conf.py
Clean up both the releasenotes 'conf.py' and some remaining pieces of
the main 'conf.py'. In the case of the former, it looks like this was
copied from Cinder's config, and retains a lot of unnecessary config for
same. Remove it all.

It is also necessary to remove a docstring from 'os_brick/__init__.py',
as this was causing build issues. No idea how this was building
previously.

Change-Id: I2ca913c2ebcf2030642b18c72af180bb8f03b288
2017-08-08 15:44:29 +01:00
Van Hung Pham
b2cc3c99f7 doc: Switch from oslosphinx to openstackdocstheme
Change-Id: Iedc8d2b1f75701b7fa92c53629b60701e2a2e659
2017-08-08 15:44:21 +01:00
Alfredo Moralejo
45145eb9c9 Retire ISERConnector from documentation
ISERConnector was retired in https://review.openstack.org/#/c/193451
but it remains in the documentation. This produces errors at
build time.

Change-Id: I76918931264816a04fca981e02bdaafd59072dd9
2016-04-27 05:48:08 -04:00
Sean McGinnis
4b3dbdcb2f Add reno for release notes management
Adopt reno for release notes like we have done for cinder.
One difference for the client is we will not be backporting
to Liberty per recommendation here [1].

[1] http://lists.openstack.org/pipermail/openstack-dev/2015-November/080694.html

Change-Id: I8f0ea1e23cb60d9f5a2a41ee440c47716bb7a3f8
2016-01-20 19:19:36 -06:00
Doug Hellmann
11355ac583 Use pbr's automatically generated changelog
Manually maintaining the changelog leads to issues when the anticipated
version does not match the version actually tagged. Use pbr's facility
for building a rst changelog automatically instead, to ensure that the
published documentation matches the package.

Change-Id: I9cd8ff88aeebc15db48f47c731725a6b0da152b5
2015-07-17 17:33:42 +00:00
Mike Perez
3818872167 Update changelog to 0.3.0 being latest
Switch from 0.2.1 to 0.3.0 per recommendation of release team of this
introducing new drivers.

Change-Id: I20fdb683bd3fafcf0694ad6220ede86558fd3146
2015-07-14 12:23:09 -07:00
Mike Perez
7993a70a39 Prep for 0.2.1 release
Change-Id: Ic057bad9e7ab3816ffa7d5c4b7930adc685ab43a
2015-07-08 17:42:32 -07:00
Mike Perez
28f3d0950f Preparing for the 0.1.1 release
This is to resolve some conflict issues we're seeing in
global-requirements.

Change-Id: Ib523337c13c49e7fd63bab8ab8738a5b60c1cee2
2015-05-19 12:19:10 -07:00
Walter A. Boring IV
b3a392e5a2 Update the documentation for os-brick
This patch intends to update the base documenation that is built
for the os-brick library.  It includes the API documentation,
changelog, tutorial.

You can generate the documentation by running:
tox -edocs

DocImpact
Change-Id: Ia0fe0118207bbdc3cf698dfe09c0b71ebddd57f3
2015-02-19 14:37:13 -08:00
Walter A. Boring IV
81b1dbebdf Created the Brick library from Cinder
This is the external Brick library that came from
Cinder's codebase.  It's intended to be used as a
standalone library and subproject of Cinder.
2015-01-22 19:09:30 +00:00