pydoctor.sphinx

module documentation

Support for Sphinx compatibility.
Class ​Cache​T Undocumented
Class ​Intersphinx​Cache An Intersphinx cache.
Class ​Invalid​Max​Age Raised when a string cannot be parsed as a maximum age.
Class ​Sphinx​Inventory Sphinx inventory handler.
Class ​Sphinx​Inventory​Writer Sphinx inventory handler.
Function parse​Max​Age Parse a string into a maximum age dictionary.
Function prepare​Cache Prepare an Intersphinx cache.
Constant MAX​_AGE​_DEFAULT Undocumented
Constant MAX​_AGE​_HELP Undocumented
Constant USER​_INTERSPHINX​_CACHE Undocumented
Variable logger Undocumented
Class _​Unit A unit of time for maximum age parsing.
Function _parse​Inventory​Line Parse a single line from a Sphinx inventory. @raise ValueError: If the line does not conform to the syntax.
Variable _max​Age​Unit​Names Undocumented
Variable _max​Age​Units Undocumented
def parseMaxAge(maxAge):
Parse a string into a maximum age dictionary.
Parameters
max​Age:strA string consisting of an integer number followed by a single character unit.
Returns
Dict[str, int]A dictionary whose keys match datetime.timedelta's arguments.
Raises
InvalidMaxAgewhen a string cannot be parsed.
def prepareCache(clearCache, enableCache, cachePath, maxAge, sessionFactory=requests.Session):
Prepare an Intersphinx cache.
Parameters
clear​Cache:boolRemove the cache?
enable​Cache:boolEnable the cache?
cache​Path:strPath of the cache directory.
max​Age:strThe maximum age in seconds of cached Intersphinx objects.inv files.
session​Factory:Callable[[], requests.Session](optional) A zero-argument callable that returns a requests.Session.
Returns
IntersphinxCacheA IntersphinxCache instance.
MAX_AGE_DEFAULT: str =

Undocumented

Value
'1w'
MAX_AGE_HELP =

Undocumented

Value
textwrap.dedent(f"""
    The maximum age of any entry in the cache.  Of the format
    <int><unit> where <unit> is one of {_maxAgeUnitNames}.
    """)
USER_INTERSPHINX_CACHE =

Undocumented

Value
appdirs.user_cache_dir('pydoctor')
logger =

Undocumented

def _parseInventoryLine(line):
Parse a single line from a Sphinx inventory.
Parameters
line:strUndocumented
Returns
Tuple[str, str, int, str, str]Undocumented
Raises
ValueErrorIf the line does not conform to the syntax.
_maxAgeUnitNames =

Undocumented

_maxAgeUnits =

Undocumented