Split more of doctest.py functionality into external modules

Registered by Roger Luethi on 2014-06-06

openstack-doc-tools's doctest.py is currently hard to edit, audit, test, and re-use because almost all its functionality is in one module ("almost" because it shares common.py with commands.py). Having more code in external modules will address these short-comings.

Blueprint information

Status:
Complete
Approver:
Tom Fifield
Priority:
Low
Drafter:
Roger Luethi
Direction:
Approved
Assignee:
Roger Luethi
Definition:
Approved
Series goal:
Accepted for juno
Implementation:
Implemented
Milestone target:
milestone icon juno
Started by
Roger Luethi on 2014-06-06
Completed by
Tom Fifield on 2014-10-08

Related branches

Sprints

Whiteboard

I'll start with the JSON check. There's already an (unused) external module in the repo which provides functionality that is not yet covered by doctest.

Gerrit topic: https://review.openstack.org/#q,topic:bp/modularize-doctest,n,z

Addressed by: https://review.openstack.org/98574
    jsoncheck: split process_one_file from main

Addressed by: https://review.openstack.org/98578
    remove jsoncheck's check_format()

Addressed by: https://review.openstack.org/99285
    jsoncheck: make formatting check optional

Addressed by: https://review.openstack.org/101450
    Add a public interface to jsoncheck.py

Addressed by: https://review.openstack.org/112302
    jsoncheck: fix handling of formatting argument

Addressed by: https://review.openstack.org/112489
    jsoncheck: fix _indent_note for pre-formatted strings

Addressed by: https://review.openstack.org/113187
    jsoncheck: indent strings only when printing them

Addressed by: https://review.openstack.org/113193
    jsoncheck: use ValueError to pass errors to outside callers

Addressed by: https://review.openstack.org/114816
    Use jsoncheck in doctest

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.