While reviewing #187, I was reminded of how our docs build can be slow and failure-prone because we use iPython to evaluate the example code, and that means building docs makes real requests to the Wayback Machine. Not great.
Example:
|
Search for all Wayback's records for nasa.gov. |
|
|
|
.. ipython:: python |
|
|
|
results = client.search('nasa.gov') |
|
|
Ideally, we can set up VCR in the docs examples using ipython_execlines or similar, similar to how we use VCR in tests. That way, the examples don’t actually go out and make live requests of the Wayback Machine.
If there’s no workable or reasonable way to do that, we should switch all those example code blocks off iPython (maybe just remove iPython altogether), since I think it’s probably causing for harm and instability than good right now.
While reviewing #187, I was reminded of how our docs build can be slow and failure-prone because we use iPython to evaluate the example code, and that means building docs makes real requests to the Wayback Machine. Not great.
Example:
wayback/docs/source/usage.rst
Lines 21 to 26 in 195add2
Ideally, we can set up VCR in the docs examples using
ipython_execlinesor similar, similar to how we use VCR in tests. That way, the examples don’t actually go out and make live requests of the Wayback Machine.If there’s no workable or reasonable way to do that, we should switch all those example code blocks off iPython (maybe just remove iPython altogether), since I think it’s probably causing for harm and instability than good right now.