From a331494c289f9e1af042880a9329f197f0b06a56 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Thu, 14 Mar 2024 17:09:09 -0700 Subject: [PATCH 1/4] Update titles and subtitles on landing page template --- Doc/tools/templates/indexcontent.html | 48 +++++++++++++-------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/Doc/tools/templates/indexcontent.html b/Doc/tools/templates/indexcontent.html index 1e3ab7cfe02fee..a6c7bc697ac1a0 100644 --- a/Doc/tools/templates/indexcontent.html +++ b/Doc/tools/templates/indexcontent.html @@ -7,62 +7,62 @@

{{ docstitle|e }}

{% trans %}Welcome! This is the official documentation for Python {{ release }}.{% endtrans %}

-

{% trans %}Parts of the documentation:{% endtrans %}

+

{% trans %}Documentation sections:{% endtrans %}

{% trans %}What's new in Python {{ version }}?{% endtrans %}
- {% trans whatsnew_index=pathto("whatsnew/index") %}or all "What's new" documents since 2.0{% endtrans %}

+ {% trans whatsnew_index=pathto("whatsnew/index") %}or All "What's new" documents since Python 2.0{% endtrans %}

{% trans %}Tutorial{% endtrans %}
- {% trans %}start here{% endtrans %}

+ {% trans %}A tour of Python's syntax and features (start here){% endtrans %}

{% trans %}Library Reference{% endtrans %}
- {% trans %}keep this under your pillow{% endtrans %}

+ {% trans %}Standard Library (keep this under your pillow){% endtrans %}

{% trans %}Language Reference{% endtrans %}
- {% trans %}describes syntax and language elements{% endtrans %}

+ {% trans %}Syntax and language elements{% endtrans %}

{% trans %}Python Setup and Usage{% endtrans %}
- {% trans %}how to use Python on different platforms{% endtrans %}

+ {% trans %}How to install, configure, and use Python{% endtrans %}

{% trans %}Python HOWTOs{% endtrans %}
- {% trans %}in-depth documents on specific topics{% endtrans %}

+ {% trans %}In-depth reference documents{% endtrans %}

{% trans %}Installing Python Modules{% endtrans %}
- {% trans %}installing from the Python Package Index & other sources{% endtrans %}

+ {% trans %}Third-party modules and PyPI.org{% endtrans %}

{% trans %}Distributing Python Modules{% endtrans %}
- {% trans %}publishing modules for installation by others{% endtrans %}

+ {% trans %}Publishing modules for use by other people{% endtrans %}

{% trans %}Extending and Embedding{% endtrans %}
- {% trans %}tutorial for C/C++ programmers{% endtrans %}

-

{% trans %}Python/C API{% endtrans %}
- {% trans %}reference for C/C++ programmers{% endtrans %}

+ {% trans %}For C/C++ programmers{% endtrans %}

+

{% trans %}Python's C API{% endtrans %}
+ {% trans %}C API reference{% endtrans %}

{% trans %}FAQs{% endtrans %}
- {% trans %}frequently asked questions (with answers!){% endtrans %}

+ {% trans %}Frequently asked questions (with answers!){% endtrans %}

-

{% trans %}Indices and tables:{% endtrans %}

+

{% trans %}Indices, glossary, and search:{% endtrans %}

{% trans %}Global Module Index{% endtrans %}
- {% trans %}quick access to all modules{% endtrans %}

+ {% trans %}All modules and libraries{% endtrans %}

{% trans %}General Index{% endtrans %}
- {% trans %}all functions, classes, terms{% endtrans %}

+ {% trans %}All functions, classes, and terms{% endtrans %}

{% trans %}Glossary{% endtrans %}
- {% trans %}the most important terms explained{% endtrans %}

+ {% trans %}Terms explained{% endtrans %}

 -

{% trans %}Search page{% endtrans %}
- {% trans %}search this documentation{% endtrans %}

+

{% trans %}Search Page{% endtrans %}
+ {% trans %}Search this documentation{% endtrans %}

{% trans %}Complete Table of Contents{% endtrans %}
- {% trans %}lists all sections and subsections{% endtrans %}

+ {% trans %}Lists all sections and subsections{% endtrans %}

-

{% trans %}Meta information:{% endtrans %}

+

{% trans %}Project information:{% endtrans %}

-

{% trans %}Reporting bugs{% endtrans %}

+

{% trans %}Reporting Issues{% endtrans %}

{% trans %}Contributing to Docs{% endtrans %}

-

{% trans %}About the documentation{% endtrans %}

+

{% trans %}About the Documentation{% endtrans %}

{% trans %}History and License of Python{% endtrans %}

{% trans %}Copyright{% endtrans %}

-

{% trans %}Download the documentation{% endtrans %}

+

{% trans %}Download the Documentation{% endtrans %}

{% endblock %} From 40d21b07c43d194a93a5612c77aa4411c5cb01a5 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 16 Mar 2024 14:24:51 -0700 Subject: [PATCH 2/4] address review from gvanrossum --- Doc/tools/templates/indexcontent.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/tools/templates/indexcontent.html b/Doc/tools/templates/indexcontent.html index a6c7bc697ac1a0..17a05b335d9dc4 100644 --- a/Doc/tools/templates/indexcontent.html +++ b/Doc/tools/templates/indexcontent.html @@ -15,13 +15,13 @@

{{ docstitle|e }}

{% trans %}Tutorial{% endtrans %}
{% trans %}A tour of Python's syntax and features (start here){% endtrans %}

{% trans %}Library Reference{% endtrans %}
- {% trans %}Standard Library (keep this under your pillow){% endtrans %}

+ {% trans %}Standard Library and builtins{% endtrans %}

{% trans %}Language Reference{% endtrans %}
{% trans %}Syntax and language elements{% endtrans %}

{% trans %}Python Setup and Usage{% endtrans %}
{% trans %}How to install, configure, and use Python{% endtrans %}

{% trans %}Python HOWTOs{% endtrans %}
- {% trans %}In-depth reference documents{% endtrans %}

+ {% trans %}In-depth topic manuals{% endtrans %}

{% trans %}Installing Python Modules{% endtrans %}
{% trans %}Third-party modules and PyPI.org{% endtrans %}

From 7e23e0d2fa688299c3f04395dd9841a954efd109 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 16 Mar 2024 14:52:13 -0700 Subject: [PATCH 3/4] Edits from hugovk review --- Doc/tools/templates/indexcontent.html | 34 +++++++++++++-------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/Doc/tools/templates/indexcontent.html b/Doc/tools/templates/indexcontent.html index 17a05b335d9dc4..7cfbc98c5efd53 100644 --- a/Doc/tools/templates/indexcontent.html +++ b/Doc/tools/templates/indexcontent.html @@ -11,23 +11,23 @@

{{ docstitle|e }}

{% trans %}What's new in Python {{ version }}?{% endtrans %}
- {% trans whatsnew_index=pathto("whatsnew/index") %}or All "What's new" documents since Python 2.0{% endtrans %}

+ {% trans whatsnew_index=pathto("whatsnew/index") %}Or all "What's new" documents since Python 2.0{% endtrans %}

{% trans %}Tutorial{% endtrans %}
- {% trans %}A tour of Python's syntax and features (start here){% endtrans %}

-

{% trans %}Library Reference{% endtrans %}
- {% trans %}Standard Library and builtins{% endtrans %}

-

{% trans %}Language Reference{% endtrans %}
+ {% trans %}Start here: a tour of Python's syntax and features{% endtrans %}

+

{% trans %}Library reference{% endtrans %}
+ {% trans %}Standard library and builtins{% endtrans %}

+

{% trans %}Language reference{% endtrans %}
{% trans %}Syntax and language elements{% endtrans %}

-

{% trans %}Python Setup and Usage{% endtrans %}
+

{% trans %}Python setup and usage{% endtrans %}
{% trans %}How to install, configure, and use Python{% endtrans %}

{% trans %}Python HOWTOs{% endtrans %}
{% trans %}In-depth topic manuals{% endtrans %}

 -

{% trans %}Installing Python Modules{% endtrans %}
+

{% trans %}Installing Python modules{% endtrans %}
{% trans %}Third-party modules and PyPI.org{% endtrans %}

-

{% trans %}Distributing Python Modules{% endtrans %}
+

{% trans %}Distributing Python modules{% endtrans %}
{% trans %}Publishing modules for use by other people{% endtrans %}

-

{% trans %}Extending and Embedding{% endtrans %}
+

{% trans %}Extending and embedding{% endtrans %}
{% trans %}For C/C++ programmers{% endtrans %}

{% trans %}Python's C API{% endtrans %}
{% trans %}C API reference{% endtrans %}

@@ -39,16 +39,16 @@

{{ docstitle|e }}

{% trans %}Indices, glossary, and search:{% endtrans %}

-

{% trans %}Global Module Index{% endtrans %}
+

{% trans %}Global module index{% endtrans %}
{% trans %}All modules and libraries{% endtrans %}

-

{% trans %}General Index{% endtrans %}
+

{% trans %}General index{% endtrans %}
{% trans %}All functions, classes, and terms{% endtrans %}

{% trans %}Glossary{% endtrans %}
{% trans %}Terms explained{% endtrans %}

 -

{% trans %}Search Page{% endtrans %}
+

{% trans %}Search page{% endtrans %}
{% trans %}Search this documentation{% endtrans %}

-

{% trans %}Complete Table of Contents{% endtrans %}
+

{% trans %}Complete table of contents{% endtrans %}
{% trans %}Lists all sections and subsections{% endtrans %}

@@ -56,13 +56,13 @@

{{ docstitle|e }}

{% trans %}Project information:{% endtrans %}

-

{% trans %}Reporting Issues{% endtrans %}

+

{% trans %}Reporting issues{% endtrans %}

{% trans %}Contributing to Docs{% endtrans %}

-

{% trans %}About the Documentation{% endtrans %}

+

{% trans %}About the documentation{% endtrans %}

 -

{% trans %}History and License of Python{% endtrans %}

+

{% trans %}License and history of Python{% endtrans %}

{% trans %}Copyright{% endtrans %}

-

{% trans %}Download the Documentation{% endtrans %}

+

{% trans %}Download the documentation{% endtrans %}

{% endblock %} From 468a168f7556db3a755d3119c12276f0c7167f03 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 16 Mar 2024 16:55:19 -0700 Subject: [PATCH 4/4] Change word order back. Down the road we should split license and history --- Doc/tools/templates/indexcontent.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/tools/templates/indexcontent.html b/Doc/tools/templates/indexcontent.html index 7cfbc98c5efd53..5b3c174f9d1729 100644 --- a/Doc/tools/templates/indexcontent.html +++ b/Doc/tools/templates/indexcontent.html @@ -60,7 +60,7 @@

{{ docstitle|e }}

{% trans %}Contributing to Docs{% endtrans %}

{% trans %}About the documentation{% endtrans %}

 -

{% trans %}License and history of Python{% endtrans %}

+

{% trans %}History and license of Python{% endtrans %}

{% trans %}Copyright{% endtrans %}

{% trans %}Download the documentation{% endtrans %}