This is the theme for the Python documentation.

It requires Python 3.10 or newer and Sphinx3.4 or newer.

It requires Python 3.10 or newer and Sphinx7.2 or newer.

Note that when adopting this theme, you're also borrowing an element of the

trust and credibility established by the CPython core developers over the

"Topic :: Software Development :: Documentation",

]

dependencies = [

"sphinx>=3.4",

"sphinx>=7.2",

]

urls.Code ="https://github.com/python/python-docs-theme"

from __future__importannotations

importsphinx.application

fromsphinx.builders.htmlimportStandaloneHTMLBuilder

THEME_PATH=Path(__file__).parent.resolve()

def_asset_hash(path:str)->str:

full_path=THEME_PATH/path.replace("_static/","static/")

digest=hashlib.sha1(full_path.read_bytes()).hexdigest()

def_add_asset_hashes(static:list[str],add_digest_to:list[str])->None:

forassetinadd_digest_to:

index=static.index(asset)

static[index].filename=_asset_hash(asset)# type: ignore[attr-defined]

def_html_page_context(

app:sphinx.application.Sphinx,

pagename:str,

templatename:str,

context:dict[str,Any],

doctree:Any,

)->None:

ifapp.config.html_theme!="python_docs_theme":

assertisinstance(app.builder,StandaloneHTMLBuilder)

if (4,)<=sphinx.version_info< (7,1)and"css_files"incontext:

if"_static/pydoctheme.css"notincontext["css_files"]:

raiseValueError(

)

_add_asset_hashes(

context["css_files"],

["_static/pydoctheme.css"],

)

defsetup(app):

app.require_sphinx("3.4")

app.require_sphinx("7.2")

current_dir=os.path.abspath(os.path.dirname(__file__))

app.add_html_theme("python_docs_theme",current_dir)

app.connect("html-page-context",_html_page_context)

return {

"version":"2024.12",

"parallel_read_safe":True,

}

#sidebarbutton {

height:100%;

background-color:#CCCCCC;

margin-left:0;

color:#444444;

font-size:1.2em;

cursor: pointer;

padding-top:1px;

float: right;

display: table;

width:12px;

border-radius:05px5px0;

border-left: none;

}

#sidebarbuttonspan {

display: table-cell;

vertical-align: middle;

}

#sidebarbutton:hover {

background-color:#AAAAAA;

}