Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cache for intersphinx inventories #120

Closed
adiroiban opened this issue Jul 23, 2016 · 1 comment · Fixed by #143
Closed

Add cache for intersphinx inventories #120

adiroiban opened this issue Jul 23, 2016 · 1 comment · Fixed by #143

Comments

@adiroiban
Copy link
Member

adiroiban commented Jul 23, 2016

Sometimes the intersphinx inventories are down

In this case, it would help to use a cached version, rather than to generate a documentation with invalid links...

The cache can have an expire age (ex 1 week), to prevent the case when the documentation was permanently moved or is permanently down

The cache can be placed in ~/.cache/pydoctor so that we can persist the cache in Travis-CI

We can start with Linux/Unix only cache support ... but maybe is easy to put it in APPDATA on Windows

There can also be a flat to disable cache --cache-age=0 so that at a release we are forced to check the state of external api docs.


We use pydoctor as part of the Twisted's test suite and I hope that with the cache we can prevent false failures due to temporary unavailability of a API doc site.

@adiroiban
Copy link
Member Author

maybe use requests and then use https://pypi.python.org/pypi/requests-cache

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant