PYDOC-7: Add python logo to top of sidebar + breadcrumb root.

.gitignore

@@ -1,3 +1,14 @@
+##########################################################################
+# Added by this RTD fork repo:
+#    https://github.com/python-docs-101/Python-Documentation-Theme-Fork
+##########################################################################
+.config/*
+__notes__*
+
+##########################################################################
+# Original .gitignore below this comment
+##########################################################################
+
 #####
 # First, rules intended to apply in all subdirectories.
 # These contain no slash, or only a trailing slash.

Doc/_static/css_for_fork/py_rtd_fork.css

@@ -0,0 +1,92 @@
+/* Import from original theme. */
+pre {
+    padding: 5px;
+    background-color: #eeffcc;
+    color: #333333;
+    line-height: 120%;
+    border: 1px solid #ac9;
+    border-left: none;
+    border-right: none;
+}
+
+/* Import from original theme. */
+div.body a {
+    color: #0072aa;
+}
+div.body a:visited {
+    color: #6363bb;
+}
+div.body a:hover {
+    color: #00B0E4;
+}
+/* minor edit to add scope `div.wy-nav-content` to fix sidebar */
+div.wy-nav-content a code span.pre {
+    color: #2980b9;
+}
+
+/* Import from original theme.
+   Fixes an awful issue where RTD theme settings made non-hyperlinks look like hyperlinks.
+*/
+html.writer-html4 .rst-content dl:not(.docutils)>dt, html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt {
+    color: #222222;
+}
+
+/* Import from original theme.
+   Make inline code blocks look more like GitHub and Slack
+*/
+code,
+.rst-content code,
+.rst-content code.literal,
+.rst-content tt,
+.rst-content tt.literal {
+    color: #333333;
+    padding: 0 1px 0 1px;
+    font-size: 0.95em;
+    background-color: #ecf0f3;
+}
+
+/* Import from original theme. */
+a.headerlink {
+    visibility: hidden;
+}
+
+a.brackets:before {
+    content: "[";
+}
+
+a.brackets:after {
+    content: "]";
+}
+
+
+/* Import from original theme. */
+span.linkdescr {
+    font-style: italic;
+    padding-top: 5px;
+    font-size: 90%;
+}
+a.biglink {
+    font-size: 1.3em;
+}
+
+div.footer {
+    line-height: 150%;
+    margin-top: -2em;
+    text-align: right;
+    width: auto;
+    margin-right: 10px;
+    font-size: 75%;
+    padding: 9px 0 9px 0;
+}
+
+
+a.icon.icon-home::before {
+    content: '';
+    height: 21px;
+    width: 21px;
+    margin-left: -8px;
+    margin-bottom: -4px;
+    background: url(https://python-docs-101.github.io/_static/py.svg);
+    background-size: 19px 20px;
+    background-repeat: no-repeat;
+}

Doc/conf.py

@@ -85,16 +85,146 @@
 # Options for HTML output
 # -----------------------
 
-# Use our custom theme.
-html_theme = 'python_docs_theme'
-html_theme_path = ['tools']
+
+##<>=========================================================
+## @@~@@ FORK MODIFIES THIS SECTOION -- replaced
+##===========================================================
+## Original options using `html_theme = 'python_docs_theme'`
+##===========================================================
+# # Use our custom theme.
+# html_theme = 'python_docs_theme'
+# html_theme_path = ['tools']
+# html_theme_options = {
+#     'collapsiblesidebar': True,
+#     'issues_url': '/bugs.html',
+#     'license_url': '/license.html',
+#     'root_include_title': False   # We use the version switcher instead.
+# }
+##</>========================================================
+
+
+##<>=========================================================
+## @@~@@ FORK MODIFIES THIS SECTOION -- added
+##===========================================================
+## Original options using `html_theme = 'python_docs_theme'`
+##===========================================================
+html_theme = 'sphinx_rtd_theme'
+html_theme_path = ['']
+html_favicon = '_static/py.svg'
+# html_logo = '_static/py.svg'
 html_theme_options = {
-    'collapsiblesidebar': True,
+    #-------------------------------------------------------------------
+    # Add these variables manually to:
+    #   Doc/venv/lib/python3.9/site-packages/sphinx_rtd_theme/theme.conf
+    # then they can be accessed via theme_issues_url + theme_license_url
+    #-------------------------------------------------------------------
     'issues_url': '/bugs.html',
     'license_url': '/license.html',
-    'root_include_title': False   # We use the version switcher instead.
+
+    #***************************************************************
+    # DOCS: sphinx_rtd_theme :       collapse_navigation           * 
+    #***************************************************************
+    # Poorly named.                                                *
+    #                                                              *
+    # From     sphinx-rtd-theme.readthedocs.io:                    *
+    #                                                              *
+    #      Type:        boolean                                    *
+    #      Default:     True                                       *
+    #                                                              *
+    #      Description:                                            *
+    #                                                              *
+    #         With collapse_navigation enabled                     *
+    #                                                              * 
+    #            Navigation entries are not expandable             * 
+    #            – the [+] icons next to each entry are removed.   * 
+    #                                                              *
+    #***************************************************************
+    # This really means,                                           *
+    # "Do you want to collapse all the nav                         *
+    #  and not include sub-pages?"                                 *
+    #                                                              *
+    # We want to tell it:                                          *
+    #	"False, I wish to include sub-pages."                      *
+    #***************************************************************
+    'collapse_navigation': False,
+
+    #**********************************************************************
+    # DOCS: sphinx_rtd_theme :        navigation_depth                    *
+    #**********************************************************************
+    #                                                                     *
+    # From     sphinx-rtd-theme.readthedocs.io:                           *
+    #                                                                     *
+    #      Type:        integer                                           *
+    #      Default:     4                                                 *
+    #                                                                     *
+    #      Description:                                                   *
+    #                   The maximum depth of the table of contents tree.  *
+    #                   Set this to -1 to allow unlimited depth.          *
+    #                                                                     *
+    #**********************************************************************
+    'navigation_depth': -1,
+
+    #************************************************************
+    # DOCS: sphinx_rtd_theme :        titles_only               *
+    #************************************************************
+    #                                                           *
+    # From     sphinx-rtd-theme.readthedocs.io:                 *
+    #                                                           *
+    #      Type:        boolean                                 *
+    #      Default:     False                                   *
+    #                                                           *
+    #      Description:                                         *
+    #                   When enabled, page subheadings          *
+    #                   are not included in the navigation.     *
+    #                                                           *
+    #************************************************************
+    'titles_only': False,
+
+    #************************************************************
+    #  DOCS: sphinx_rtd_theme :           warning               *
+    #************************************************************
+    #                                                           *
+    #  Note:                                                    *
+    #                                                           *
+    #   Setting collapse_navigation to False                    *
+    #   and using a high value for navigation_depth             *
+    #   on projects with many files and a deep file structure   *
+    #                                                           *
+    #   can cause long compilation times                        *
+    #   and can result in HTML files                            *
+    #     that are significantly larger in file size.           *
+    #                                                           *
+    #************************************************************
 }
 
+##</>========================================================
+## @@~@@ FORK MODIFIES THIS SECTOION -- added
+## endof update
+##===========================================================
+
+##-------------------------------------------------------------------------
+## <>  RTD CSS Config
+##-------------------------------------------------------------------------
+## See
+##     https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html
+##-------------------------------------------------------------------------
+# These folders are copied to the documentation's HTML output
+html_static_path = ['_static']
+
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+html_css_files = [
+    'css_for_fork/py_rtd_fork.css',
+]
+##-------------------------------------------------------------------------
+## </> RTD CSS Config
+##-------------------------------------------------------------------------
+
+
+
+
+
+
 # Override stylesheet fingerprinting for Windows CHM htmlhelp to fix GH-91207
 # https://github.com/python/cpython/issues/91207
 if any('htmlhelp' in arg for arg in sys.argv):

Doc/contents.rst

@@ -2,29 +2,40 @@
  Python Documentation contents
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-.. toctree::
+.. |hr| raw:: html
+
+   <hr>
 
+.. toctree::
+
    whatsnew/index.rst
+   ---------------------- <glossary.rst>
    tutorial/index.rst
-   using/index.rst
-   reference/index.rst
    library/index.rst
+   reference/index.rst
+   using/index.rst
+   howto/index.rst
+
+   ---------------------- <glossary.rst>
+   installing/index.rst
+   distributing/index.rst
    extending/index.rst
    c-api/index.rst
-   distributing/index.rst
-   installing/index.rst
-   howto/index.rst
    faq/index.rst
+
+   ---------------------- <glossary.rst>
+
+   Python Module Index <https://python-docs-101.github.io/py-modindex.html>
+   General Index <https://python-docs-101.github.io/genindex.html>
+   Search page <https://python-docs-101.github.io/search.html>
+   Complete TOC <https://python-docs-101.github.io/contents.html>
    glossary.rst
-
+
+   ---------------------- <glossary.rst>
    about.rst
+   Contributing to Docs <https://devguide.python.org/documentation/help-documenting/index.html#helping-with-documentation>
    bugs.rst
-   copyright.rst
    license.rst
+   copyright.rst
 
 .. to include legacy packaging docs in build
-
-.. toctree::
-   :hidden:
-
-   install/index.rst

Doc/installing/index.rst

@@ -239,3 +239,9 @@ obtaining other binary extensions without needing to build them locally.
 
    `Python Packaging User Guide: Binary Extensions
    <https://packaging.python.org/extensions/>`__
+
+
+.. toctree::
+   :hidden:
+
+   ../install/index.rst

Doc/requirements.txt

@@ -1,3 +1,17 @@
+##########################################################################
+# Added by this RTD fork repo:
+#    https://github.com/python-docs-101/Python-Documentation-Theme-Fork
+##########################################################################
+
+sphinx_rtd_theme
+
+
+
+##########################################################################
+# Original requirements.txt below this comment
+##########################################################################
+
+
 # Requirements to build the Python documentation
 
 # Sphinx version is pinned so that new versions that introduce new warnings

Doc/tools/templates/footerdonate.html

@@ -0,0 +1,3 @@
+{% trans %}The Python Software Foundation is a non-profit corporation.{% endtrans %}
+<a href="https://www.python.org/psf/donations/">{% trans %}Please donate.{% endtrans %}</a>
+<br />

Doc/tools/templates/indexcontent.html

@@ -5,8 +5,24 @@
 {% block body %}
   <h1>{{ docstitle|e }}</h1>
   <p>
-  {% trans %}Welcome! This is the official documentation for Python {{ release }}.{% endtrans %}
+  {% trans %}Welcome! This is
+    <a href="https://github.com/python-docs-101/python-docs-101.github.io">
+      <strong style="font-size:larger;">
+        <code>A FORK OF</code>
+      </strong>
+    </a>
+    the official documentation for Python {{ release }}.{% endtrans %}
   </p>
+  <div style="background-color:#edf0f2; padding-left:7px;"><br>
+    <span style="font-size:larger;">Fork note:</span><br><br>
+      <p style="padding-left: 3vw;">
+      ◀ We added a TOC sidebar to this entire site!
+      <br> 
+      Otherwise, the rest of this repo is identical to the main docs at <a href="https://docs.python.org/">https://docs.python.org</a>
+      </p>
+    <span style="font-size:larger;">Happy coding 👩‍💻</span><br><br>
+  </div>
+  <br>
   <p><strong>{% trans %}Parts of the documentation:{% endtrans %}</strong></p>
   <table class="contentstable" align="center"><tr>
     <td width="50%">