When the wsmeext.sphinxext extension is initialized during the
documentation build it registers some autodoc classes that use the
same objtype as built-in types. This causes the associated directives
to be overridden, which emits a warning. That warning prevents us from
turning on warning-is-error in the build. Since there is nothing we
can do about it, we want to ignore it.
Change-Id: Ie74174176d6140467c60ea864dc2df4dc2287604
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Move documentation dependencies to doc/requirements.txt
Change tox.ini to run sphinx-build directly, like the zuul job does.
Switch from oslosphinx to openstackdocstheme.
Change-Id: I079ff78edacaba673461824af770344cb3a896f2
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The goal of this patch is to setup infrastructure and organization
of docs in the project.
Changes:
* Added documentation for REST objects along with examples
* Added documentation for REST endpoints
* Added auto-generation of REST API docs
Note(1):
New API endpoint will not be auto-added to the docs. It is responibility
of committer to add new endpoint to the docs.
Note(2):
Usage examples still need to be added manually.
Change-Id: I080a6daba2fdb8a1a6a18087c7b3929da5b4bf1a
As a step towards continuous deployment and having a pecan/WSME REST
interface, split the database out into SQLalchemy-based model using
Alembic for migrations. To support that, also pull in oslo.db and use
oslo.config for config files.
Change-Id: I33a1e72700be14e28255aaa52faed70c4686a3ec
Doug Hellmann