version:Version

language:Language

cpython_repo:Repository

indexsidebar_content:bytes

docs_by_version_content:bytes

switchers_content:bytes

build_root:Path

www_root:Path

text=text.replace(" -A switchers=1","")

(self.checkout/"Doc"/"Makefile").write_text(text,encoding="utf-8")

indexsidebar_path=self.checkout/"Doc/tools/templates/indexsidebar.html"

indexsidebar_path.write_bytes(self.indexsidebar_content)

self.setup_indexsidebar()

run_with_logging([

"make",

"-C",

run([venv_path/"bin"/"python","-m","pip","freeze","--all"])

self.venv=venv_path

defsetup_indexsidebar(self)->None:

tmpl_dst=self.checkout/"Doc"/"tools"/"templates"

shutil.copy(tmpl_src/"indexsidebar.html",tmpl_dst/"indexsidebar.html")

ifself.version.status!="EOL":

dbv_path.write_bytes(self.docs_by_version_content)

else:

shutil.copy(tmpl_src/"_docs_by_version.html",dbv_path)

defcopy_build_to_webroot(self,http:urllib3.PoolManager)->None:

logging.info("Publishing start.")

force_build=args.force

delargs.force

isb_content,eol_isb_content=render_indexsidebar(versions)

docs_by_version_content=render_docs_by_version(versions).encode()

switchers_content=render_switchers(versions,languages)

build_succeeded=set()

scope.set_tag("version",version.name)

scope.set_tag("language",language.tag)

cpython_repo.update()

v_isb_content=isb_contentifversion.status!="EOL"elseeol_isb_content

builder=DocBuilder(

version,

versions,

language,

cpython_repo,

v_isb_content,

docs_by_version_content,

switchers_content,

**vars(args),

)

returnLanguages.from_json(config["defaults"],config["languages"])

defrender_indexsidebar(versions:Versions)->tuple[bytes,bytes]:

template=Template(template_path.read_text(encoding="UTF-8"))

rendered_template=template.substitute(DOCS_BY_VERSION=docs_by_version).encode()

eol_template=template.substitute(DOCS_BY_VERSION="").encode()

returnrendered_template,eol_template

defrender_docs_by_version(versions:Versions)->str:

links= [f'<li><a href="{v.url}">{v.title}</a></li>'forvinreversed(versions)]

return"\n".join(links)

defrender_switchers(versions:Versions,languages:Languages)->bytes:

{#

This file is only used in indexsidebar.html, where it is included in the docs

by version list. For non-end-of-life branches, build_docs.py overwrites this

list with the full list of versions.

Keep the following two files synchronised:

* cpython/Doc/tools/templates/_docs_by_version.html

* docsbuild-scripts/templates/_docs_by_version.html

#}

<li><ahref="https://docs.python.org/3/">{% trans %}Stable{% endtrans %}</a></li>

<li><ahref="https://docs.python.org/dev/">{% trans %}In development{% endtrans %}</a></li>

{#

Beware, this file is rendered twice:

- First by build_docs.py using string.Template, given '$DOCS_BY_VERSION'.

- Second time by Sphinx, using Jinja.

#}

<h3>{% trans %}Download{% endtrans %}</h3>

<p><ahref="{{ pathto('download') }}">{% trans %}Download these documents{% endtrans %}</a></p>

$DOCS_BY_VERSION

<h3>{% trans %}Docs by version{% endtrans %}</h3>

{# _docs_by_version.html is overwritten by build_docs.py for non-EOL versions #}

{% include "_docs_by_version.html" without context %}

<li><ahref="https://www.python.org/doc/versions/">{% trans %}All versions{% endtrans %}</a></li>

<h3>{% trans %}Other resources{% endtrans %}</h3>

{# XXX: many of these should probably be merged in the main docs #}