Actions
Refactor #113
closed
Rework all documented API examples to be doctests so that we can ensure they are accurate
Status:
CLOSED - WONTFIX
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:
0%
Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Pulp 2
Sprint:
Quarter:
Description
It is very common for our API examples in the documentation to become inaccurate as we make changes. Sphinx has the ability to ensure that examples are accurate against the current code if we format our rst files correctly. We should take advantage of this feature so that when we build the docs our examples are checked for accuracy. We should also have run-tests.py run the doctests.
Actions
.