3 Commits

Author SHA1 Message Date
Ryan Rossiter
8c1179b386 ObjectVersionChecker fingerprint documentation
This adds documentation for how the process of fingerprint generation
works when using the ObjectVersionChecker.

Change-Id: Ie21746f6c2bab447a187b0b7507acdcea3d88c14
2015-09-03 20:24:35 +00:00
Doug Hellmann
3f9f2e1199 Move fixture dependencies to extras
Rather than always installing dependencies for the test tools included
in the library, define an extras called "test" and include the
dependencies there.

Add API documentation for the fixture module, and include notes about
installing the extra dependencies in the module documentation and
installation instructions.

Closes-Bug: #1440350
Depends-On: I78838dcd4da43b3c1d2610ac87a3ec55b9535646
Depends-On: Ibd2410e0153053b5121155474e99752256c7e4b8
Change-Id: I4e45c1bb4f08c9da510939514c5358e1575d3e0a
2015-07-12 18:08:01 +00:00
Victor Stinner
e2b9b2a9bc Enhance documentation
Rewrite README.rst and copy it to doc/source/index.rst to add a little
bit more content.

Generate documentation for APIs. fixture, safe_utils and test submodules
are not documented.

Fix indentation in obj_reset_changes() docstring.

Fix formatting of obj_make_list() docstring.

Co-Authored-By: Dan Smith <dansmith@redhat.com>
Change-Id: I8110919de072c5a5139e3797f256925c92656117
2015-05-15 11:32:15 +02:00