Suppress warnings from Sphinx extensions that used to be suppressed by
pbr with older versions of Sphinx.
Change-Id: I1629ebb51f32dc019d8384a3c12b1ecad204245d
The sphinxcontrib.httpdomain extension is being installed, but not
initialized. Add it to the list of extensions to eliminate warnings
about the http:get and http:post directives.
Change-Id: I034e5bfae6104d68e738f1c7a0d6c35907754342
Project documents are being reprocessed due to document migration[1].
Update the docs theme to openstackdocstheme instead of oslosphinx.
[1] https://review.openstack.org/#/c/472275/
Change-Id: I505d837cc4e60356497cd37a8c9a12f846ffdf0d
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: I4799d2c0b03ab7c03ebc9f5c5c82e955c775a2d4
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.
Change-Id: I992f38ba935536c59217e22d4071f40a69090fc2
Closes-Bug: #1552251
There's no RST file that uses ".. math" and thus
the pngmath Sphinx extension is not used and can
get removed.
Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
It is an initial seed of hacking rules based on neutron and
nova projects.
For ceilometer it prevents bug 1508442 and closes/prevents
bug 1529836.
All the requirements about the hacking rules were corrected
on this propose review.
To be clear about the requirements, the only alarmed was
about import[1], in specific H306
[H306] "Alphabetically order your imports by the full module
path. Organize your imports"
[1] http://docs.openstack.org/developer/hacking/
Change-Id: Ia530873078c97925bfb91fde87b38131426a74c2
Closes-Bug: 1529836
oslo-incubator.log_handler has been removed but still remains in
doc/source/conf.py, this patch removes it from excluded list.
Change-Id: I06c8b0513188e1f81edde880429f0698e459d166
This has not been tested for months and doesn't work anymore. There's no
way people are using it, so let's drop it until someone starts fixing it
again.
Change-Id: I7d6472a1924320c890dec47c41bf22db07a36efc
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This causes docs jobs to fail because we error out on warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
After migrating to oslo.messaging, the oslo.middleware.notifier and
oslo.middleware.audit can no longer work, we should remove these code.
Change-Id: Ie848d9f356eec670bbeeafc83f9e704212b1d2e4
Closes-Bug: #1327084
In openstack/common/db/sqlalchemy/session.py a wrong directive name was
used for formattion code snippets. The directive '.. code::' was changed
to '.. code-block::' in oslo-incubator in this commit:
I222a11d8a2101600e7cbb96f587515a32f697c2e
As this file now does not contain more formatting errors, it was removed
from the exclude list of Sphinx in conf.py.
Change-Id: I2fc7a8b8216d4bfc5232027f0beb11a036bf257c
The variable for excluding modules should be a sequence of strings.
Turn the current value from a string to a tuple so documentation
for our source is generated.
The errors and warnings were fixed in the docstrings in the source code
otherwise the doc generation would fail.
The following files were excluded from the doc build because of
non-existing imports:
'ceilometer.compute.nova_notifier'
http://bit.ly/remove-nova-notifier-bp
'ceilometer.openstack.common.db.sqlalchemy.session'
https://review.openstack.org/#/c/97850/
'ceilometer.openstack.common.middleware.audit'
'ceilometer.openstack.common.middleware.notifier'
https://bugs.launchpad.net/ceilometer/+bug/1327084
'ceilometer.openstack.common.log_handler'
https://bugs.launchpad.net/ceilometer/+bug/1327076
These failed imports are registered in one blueprint and two bug reports.
Change-Id: If0bc1c8fc96ba513bbeb90d5257e40b7621a8473
pbr config was missing from setup.cfg. With adding "warnerrors = true"
under '[pbr]' in setup.cfg, the Sphinx build will fail in case of
warnings and errors during the build process.
This patch also fixes the currently existing problems in the developer
documentation of Ceilometer. The unused todo extension was also removed.
Fixes-Bug: #1317648
Fixes-Bug: #1321193
Fixes-Bug: #1272845
Change-Id: If1a9d7aca5c1d350568a83fb49bb8ea3defefdca
The word "Copyright" alone is sufficient to claim copyright, the (c)
symbol need not be present.[1]
As per PEP 263, a Python file with non-ASCII characters must have a
line with "coding: <some-encoding>". Python files containing only
7-bit ASCII characters need no such line.[2]
This commit removes unnecessary Unicode copyright symbols and
unnecessary encoding lines.
[1]: http://www.copyright.gov/circs/circ03.pdf
[2]: http://legacy.python.org/dev/peps/pep-0263/
Closes-Bug: #1324686
Change-Id: Id381ea1f029a0cfddd3773c6d9f16c47842d9c33
Thanks to sphinxcontrib-docbookrestapi, the documentation for the REST API can
be automatically generated. Add a target to do this.
Change-Id: I9dda41bc00160bf1be1e275d9ac94a3a53571688
NOTE: openstack/common files are not touched, they should be updated
via sync with oslo.
Change-Id: I0106004a8f211d047db28f35fecd386a4e327569
Closes-Bug: #1214176
In python 3 print statement is not supported, so we should use
only print() functions.
Fixes bug 1226943
Change-Id: I206fe870eea21522e28318b9cfa062239e54c391
Use the new oslo.sphinx version of the OpenStack doc
theme instead of copying it into this repo.
blueprint oslo.sphinx
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Change-Id: I0bd91f7bb43f97b99051fed65b75fc05d5149cc8
Fix exclude rules so we do not run flake8 against code in the build,
.tox, or openstack/common directories since this code is not "ours."
Fix flake8 errors in other code.
Update the config checker script so if there are differences they
are printed to the output. This should help track down false
negatives in the tests.
Change-Id: I9938846943b7f8aab20f02266b870d560c6a2f80
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Move the ceilext code into a separate package
so it can be worked on and reused by other
projects using Pecan and WSME.
The new package is being added to the requirements
list under https://review.openstack.org/29149.
Change-Id: If38a69ed8ef654e75bb29da998fbb731143c506c
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
This changeset adds a Sphinx extension for auto-generating
much of the documentation for a Pecan/WSME API from the
comments and docstrings in the source code. It also updates
the V2 API to include more documentation for API endpoints
and the data types used in the API, as well as sample data
for generating the JSON and XML examples in the output
documentation.
Change-Id: I1bde7805550aa86e9b64495b5c6034ec328479e5
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
The files in the WSME library were rearranged
so we need to update some of our imports.
Change-Id: Ie3056483bc4011d3c84d8e033e9064f3c6e1efcd
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Move the web API documentation into the 'webapi'
subdirectory to avoid conflicts with the auto-generated
'api' directory contents. Create a v2 doc file
as a placeholder until the automatic documentation
features of WSME are more complete.
blueprint api-server-pecan-wsme
Change-Id: Ide11ad0b4cebb29318b8bb977bc5165334e22a2c
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
1. Add the version module from openstack.common.
2. Create a ceilometer/version.py to set up the
version info.
3. Update setup.py from openstack.common.
4. Update documentation build to use the version module
directly instead of running setup.py to get the version.
5. Update setup.py to use the new version module.
Change-Id: I9d8be62b8ece75090bf335d27adb59a46e3d6263
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Get the version number from the setup.py file.
Change-Id: I50efc125c8857d9a531d7a00dba53b67baf7496b
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Fix some pep8 issues in
modified: doc/source/conf.py
modified: tests/api/v1/test_list_resources.py
modified: tests/collector/test_dispatcher.py
modified: tests/compute/test_notifications.py
make the code looks pretty.
Change-Id: I50c167b457b18f3789a3f8d470faa2754a77b604
Use sphinxcontrib-httpdomain to produce documentation for
the web API. Add docstrings to the exposed functions.
See http://packages.python.org/sphinxcontrib-httpdomain/
for details about the format of the auto-generated
output.
Change-Id: I62edd1d00c048c4bce34711a23686f0089bbf4e7
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
- Add information about the system architecture (modified
from the wiki to reflect what was implemented).
- Add information about where we want contributions.
- Add information about how to sign up to participate in
the project and how to be a part of the community.
- Add more detailed instructions for installing the development
version from git.
- Add a placeholder for documenting the configuration options.
- Add instructions for running the tests after getting
the source code.
- Add a glossary and index.
tags: DocImpact
bug 1006366
Change-Id: I8927c55e77cdd31804249d101575f9e174e6232d
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
bug 1018443
This patch sets up a basic Sphinx project to allow us to
build the documentation. It also moves the "dev" docs
into the new doc source directory.
Change-Id: Ie2ad0f2e4ed237f1373c4357d5763fd5218d738a
