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