module documentation
Support for Sphinx compatibility.
Class |
|
Undocumented |
Class |
|
An Intersphinx cache. |
Class |
|
Sphinx inventory handler. |
Class |
|
Sphinx inventory handler. |
Exception |
|
Raised when a string cannot be parsed as a maximum age. |
Function | parse |
Parse a string into a maximum age dictionary. |
Function | prepare |
Prepare an Intersphinx cache. |
Constant | MAX |
Undocumented |
Constant | MAX |
Undocumented |
Constant | USER |
Undocumented |
Variable | logger |
Undocumented |
Class | _ |
A unit of time for maximum age parsing. |
Function | _parse |
Parse a single line from a Sphinx inventory. |
Variable | _max |
Undocumented |
Variable | _max |
Undocumented |
Parse a string into a maximum age dictionary.
Parameters | |
maxstr | A string consisting of an integer number followed by a single character unit. |
Returns | |
Dict[ | A dictionary whose keys match datetime.timedelta 's arguments. |
Raises | |
InvalidMaxAge | when a string cannot be parsed. |
def prepareCache(clearCache, enableCache, cachePath, maxAge, sessionFactory=requests.Session):
(source)
¶
Prepare an Intersphinx cache.
Parameters | |
clearbool | Remove the cache? |
enablebool | Enable the cache? |
cachestr | Path of the cache directory. |
maxstr | The maximum age in seconds of cached Intersphinx objects.inv files. |
sessionCallable[ | (optional) A zero-argument callable that returns a requests.Session . |
Returns | |
IntersphinxCache | A IntersphinxCache instance. |
Undocumented
Value |
|