sphinx.util

package documentation
(source)

Utility functions for Sphinx.

Module build_phase Build phase of Sphinx application.
Module cfamily Utility functions common to the C and C++ domains.
Module console Format colored console output.
Module display Undocumented
Module docfields Utility code for "Doc fields".
Module docstrings Utilities for docstring processing.
Module docutils Utility functions for docutils.
Module exceptions No module docstring; 2/2 functions documented
Module fileutil File utility functions for Sphinx.
Module http_date Convert times to and from HTTP-date serialisations.
Module i18n Builder superclass for all builders.
Module images Image utility functions for Sphinx.
Module inspect Helpers for inspecting Python modules.
Module inventory Inventory utility functions for Sphinx.
Module jsdump This module implements a simple JavaScript serializer.
Module logging Logging utility functions for Sphinx.
Module matching Pattern-matching utility functions for Sphinx.
Module math Utility functions for math.
Module nodes Docutils node-related utility functions for Sphinx.
Module osutil Operating system-related utility functions for Sphinx.
Module parallel Parallel building utilities.
Module png PNG image manipulation helpers.
Module requests Simple requests package loader
Module rst reST helper functions.
Package stemmer Word stemming utilities for Sphinx.
Module tags No module docstring; 0/1 variable, 1/2 class documented
Module template Templates utility functions for Sphinx.
Module texescape TeX escaping helper.
Module typing The composite types for Sphinx.

From __init__.py:

Class DownloadFiles A special dictionary for download files.
Class FilenameUniqDict A dictionary that automatically generates unique names for its keys, interpreted as filenames, and keeps track of a set of docnames they appear in. Used for images and downloadable files in the environment.
Class Tee File-like object writing to two streams.
Class UnicodeDecodeErrorHandler Custom error handler for open() that warns and replaces.
Function docname_join Undocumented
Function encode_uri Undocumented
Function get_filetype Undocumented
Function get_full_modname Undocumented
Function get_matching_files Get all file names in a directory, recursively.
Function import_object Import python object by qualname.
Function isurl Check *url* is URL or not.
Function md5 Wrapper around hashlib.md5
Function parselinenos Parse a line number spec (such as "1,2,4-6") and return a list of wanted line numbers.
Function sha1 Wrapper around hashlib.sha1
Function split_full_qualified_name Split full qualified name to a pair of modname and qualname.
Function split_index_msg Undocumented
Function split_into Split an index entry into a given number of parts at semicolons.
Variable logger Undocumented
Variable url_re Undocumented
Variable ws_re Undocumented
Function _xml_name_checker Undocumented
Variable _coding_re Undocumented
logger = (source)

Undocumented

ws_re: re.Pattern = (source)

Undocumented

url_re: re.Pattern = (source)

Undocumented

def docname_join(basedocname, docname): (source)

Undocumented

Parameters
basedocname:strUndocumented
docname:strUndocumented
Returns
strUndocumented
def get_matching_files(dirname, exclude_matchers=(), include_matchers=()): (source)

Get all file names in a directory, recursively. Exclude files and dirs matching some matcher in *exclude_matchers*.

Parameters
dirname:strUndocumented
exclude_matchers:tuple[PathMatcher, ...]Undocumented
include_matchers:tuple[PathMatcher, ...]Undocumented
Returns
Iterable[str]Undocumented
def get_filetype(source_suffix, filename): (source)

Undocumented

Parameters
source_suffix:dict[str, str]Undocumented
filename:strUndocumented
Returns
strUndocumented
def md5(data=b'', **kwargs): (source)

Wrapper around hashlib.md5 Attempt call with 'usedforsecurity=False' if we get a ValueError, which happens when OpenSSL FIPS mode is enabled: ValueError: error:060800A3:digital envelope routines:EVP_DigestInit_ex:disabled for fips See: https://github.com/sphinx-doc/sphinx/issues/7611

def sha1(data=b'', **kwargs): (source)

Wrapper around hashlib.sha1 Attempt call with 'usedforsecurity=False' if we get a ValueError See: https://github.com/sphinx-doc/sphinx/issues/7611

def get_full_modname(modname, attribute): (source)

Undocumented

Parameters
modname:strUndocumented
attribute:strUndocumented
Returns
str|NoneUndocumented
_coding_re = (source)

Undocumented

def parselinenos(spec, total): (source)

Parse a line number spec (such as "1,2,4-6") and return a list of wanted line numbers.

Parameters
spec:strUndocumented
total:intUndocumented
Returns
list[int]Undocumented
def split_into(n, type, value): (source)

Split an index entry into a given number of parts at semicolons.

Parameters
n:intUndocumented
type:strUndocumented
value:strUndocumented
Returns
list[str]Undocumented
def split_index_msg(type, value): (source)

Undocumented

Parameters
type:strUndocumented
value:strUndocumented
Returns
list[str]Undocumented
def import_object(objname, source=None): (source)

Import python object by qualname.

Parameters
objname:strUndocumented
source:str|NoneUndocumented
Returns
AnyUndocumented
def split_full_qualified_name(name): (source)

Split full qualified name to a pair of modname and qualname. A qualname is an abbreviation for "Qualified name" introduced at PEP-3155 (https://peps.python.org/pep-3155/). It is a dotted path name from the module top-level. A "full" qualified name means a string containing both module name and qualified name. .. note:: This function actually imports the module to check its existence. Therefore you need to mock 3rd party modules if needed before calling this function.

Parameters
name:strUndocumented
Returns
tuple[str|None, str]Undocumented
def encode_uri(uri): (source)

Undocumented

Parameters
uri:strUndocumented
Returns
strUndocumented
def isurl(url): (source)

Check *url* is URL or not.

Parameters
url:strUndocumented
Returns
boolUndocumented
def _xml_name_checker(): (source)

Undocumented