From ec38133730ccb17e003ef97acb3bdbffa2bac2b0 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Mon, 22 Jan 2018 10:05:08 +0530 Subject: [PATCH 001/260] Use documentwrapper's height of sidebar (#9) This is sort of a more correct thing to do since the first/last element of the body may have a margin that can cause the documentwrapper to be taller than bodywrapper. While this doesn't cause any major issues for this theme as is (due to the ample use of whitespace around the sidebar), this behaviour would help with derivative themes which remove the excessive margins on the sidebar. --- python_docs_theme/static/sidebar.js | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/python_docs_theme/static/sidebar.js b/python_docs_theme/static/sidebar.js index 9efc2520..0680c6c8 100644 --- a/python_docs_theme/static/sidebar.js +++ b/python_docs_theme/static/sidebar.js @@ -28,6 +28,7 @@ $(function() { var jwindow = $(window); var jdocument = $(document); var bodywrapper = $('.bodywrapper'); + var documentwrapper = $('.documentwrapper'); var sidebar = $('.sphinxsidebar'); var sidebarwrapper = $('.sphinxsidebarwrapper'); @@ -71,7 +72,7 @@ $(function() { bodywrapper.css('margin-left', bw_margin_collapsed); sidebarbutton.css({ 'margin-left': '0', - 'height': bodywrapper.height(), + 'height': documentwrapper.height(), 'border-radius': '5px' }); sidebarbutton.find('span').text('»'); @@ -85,7 +86,7 @@ $(function() { sidebarwrapper.show(); sidebarbutton.css({ 'margin-left': ssb_width_expanded-12, - 'height': Math.max(sidebarwrapper.height(), bodywrapper.height()), + 'height': Math.max(sidebarwrapper.height(), documentwrapper.height()), 'border-radius': '0 5px 5px 0' }); sidebarbutton.find('span').text('«'); @@ -109,7 +110,7 @@ $(function() { // find the height of the viewport to center the '<<' in the page var viewport_height = get_viewport_height(); var sidebar_offset = sidebar.offset().top; - var sidebar_height = Math.max(bodywrapper.height(), sidebar.height()); + var sidebar_height = Math.max(documentwrapper.height(), sidebar.height()); sidebarbutton.find('span').css({ 'display': 'block', 'position': 'fixed', From 2a7d0cc6d977232303616dc77bf2250d43abb5e9 Mon Sep 17 00:00:00 2001 From: Jon Wayne Parrott Date: Thu, 1 Feb 2018 21:37:16 -0800 Subject: [PATCH 002/260] Use date-based release numbers (#11) --- setup.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 2f25d98f..9e0d978e 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,9 @@ setup( name='python-docs-theme', - version='0.0.1', + # Version is date based as year.month[.serial], where serial is used + # if multiple releases are needed to address build failures. + version='2018.2', description='The Sphinx theme for the CPython docs and related projects', long_description=long_description, author='PyPA', From e1f920e04cc4d2bf85e03427a2afa870eab3574b Mon Sep 17 00:00:00 2001 From: Jon Wayne Parrott Date: Wed, 28 Mar 2018 13:51:28 -0700 Subject: [PATCH 003/260] Return metadata indicating that this is parallel_read_safe (#14) --- python_docs_theme/__init__.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/python_docs_theme/__init__.py b/python_docs_theme/__init__.py index ec776b71..407d62a8 100644 --- a/python_docs_theme/__init__.py +++ b/python_docs_theme/__init__.py @@ -5,3 +5,8 @@ def setup(app): current_dir = os.path.abspath(os.path.dirname(__file__)) app.add_html_theme( 'python_docs_theme', current_dir) + + return { + 'parallel_read_safe': True, + 'parallel_write_safe': True, + } From 443a60b1c634e1e8775b943f1d449f564cd75fdf Mon Sep 17 00:00:00 2001 From: Mariatta Date: Fri, 1 Jun 2018 09:28:38 -0700 Subject: [PATCH 004/260] Update the pip installation step in readme (#15) It can be installed as `pip install python-docs-theme` (much shorter to type). Remove the mention of cloning with git. --- README.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 1469624e..1ba79624 100644 --- a/README.rst +++ b/README.rst @@ -10,7 +10,6 @@ projects if you so choose, but please keep in mind that in doing so you're also choosing to accept some of the responsibility for maintaining that collective trust. -To use the theme either clone it directly with ``git``, or else install it -into your docs build environment via ``pip``:: +To use the theme, install it into your docs build environment via ``pip``:: - pip install git+https://github.com/python/python-docs-theme.git#egg=python-docs-theme + pip install python-docs-theme From 68b11a117d83b9a9463fc6feaf1a0946af9d572a Mon Sep 17 00:00:00 2001 From: zhsj Date: Wed, 11 Jul 2018 00:46:59 +0800 Subject: [PATCH 005/260] Make the search button wider to better accommodate text (#17) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit when the word "Go" translated to "搜索" in Chinese, this button seems too narrow. See example on https://zhsj.github.io/python-docs-zh-cn/ --- python_docs_theme/static/pydoctheme.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python_docs_theme/static/pydoctheme.css b/python_docs_theme/static/pydoctheme.css index 1d5c18e5..50b0fe7e 100644 --- a/python_docs_theme/static/pydoctheme.css +++ b/python_docs_theme/static/pydoctheme.css @@ -29,7 +29,7 @@ form.inline-search input { display: inline; } form.inline-search input[type="submit"] { - width: 30px; + width: 40px; } div.sphinxsidebar { From 44a8f306db9ec86d277a8a687538d5d51e415130 Mon Sep 17 00:00:00 2001 From: Thea Flowers Date: Tue, 24 Jul 2018 11:27:42 -0700 Subject: [PATCH 006/260] Release 2018.7 (#19) --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 9e0d978e..8e4a76c8 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ name='python-docs-theme', # Version is date based as year.month[.serial], where serial is used # if multiple releases are needed to address build failures. - version='2018.2', + version='2018.7', description='The Sphinx theme for the CPython docs and related projects', long_description=long_description, author='PyPA', From ea3cc21908fe0e0c3ffc852125d903493edf90e7 Mon Sep 17 00:00:00 2001 From: Mariatta Date: Fri, 10 Aug 2018 16:53:07 -0700 Subject: [PATCH 007/260] Add CoC (#22) --- code_of_conduct.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 code_of_conduct.rst diff --git a/code_of_conduct.rst b/code_of_conduct.rst new file mode 100644 index 00000000..28de97ce --- /dev/null +++ b/code_of_conduct.rst @@ -0,0 +1,14 @@ +Code of Conduct +=============== + +Please note that all interactions on +`Python Software Foundation `__-supported +infrastructure is `covered +`__ +by the `PSF Code of Conduct `__, +which includes all infrastructure used in the development of Python itself +(e.g. mailing lists, issue trackers, GitHub, etc.). + +In general this means everyone is expected to be open, considerate, and +respectful of others no matter what their position is within the project. + From 10be089395a0cb79aa50b41fddb62745476b1584 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Wirtel?= Date: Wed, 13 Feb 2019 18:08:57 +0100 Subject: [PATCH 008/260] Change the font-family for the parameters of a function (#25) Change the font-family for the parameters of a function. --- python_docs_theme/static/pydoctheme.css | 3 +++ 1 file changed, 3 insertions(+) diff --git a/python_docs_theme/static/pydoctheme.css b/python_docs_theme/static/pydoctheme.css index 50b0fe7e..2aa5bad9 100644 --- a/python_docs_theme/static/pydoctheme.css +++ b/python_docs_theme/static/pydoctheme.css @@ -192,3 +192,6 @@ div.footer a:hover { background: none !important; } +dl > dt span ~ em { + font-family: monospace, sans-serif; +} From 6487f569ac6f747e89e2ca79c86e61ed9f2337c8 Mon Sep 17 00:00:00 2001 From: Liang-Bo Wang Date: Fri, 15 Feb 2019 21:45:16 -0600 Subject: [PATCH 009/260] Fix copybutton to appear on all code examples (#26) --- python_docs_theme/static/copybutton.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/python_docs_theme/static/copybutton.js b/python_docs_theme/static/copybutton.js index 716c9e47..f5960d26 100644 --- a/python_docs_theme/static/copybutton.js +++ b/python_docs_theme/static/copybutton.js @@ -3,7 +3,9 @@ $(document).ready(function() { * the >>> and ... prompts and the output and thus make the code * copyable. */ var div = $('.highlight-python .highlight,' + - '.highlight-python3 .highlight') + '.highlight-python3 .highlight,' + + '.highlight-pycon .highlight,' + + '.highlight-default .highlight'); var pre = div.find('pre'); // get the styles from the current theme From b862f1159388ed3134818e56b065e18b835d652c Mon Sep 17 00:00:00 2001 From: Julien Palard Date: Tue, 14 May 2019 16:02:57 +0200 Subject: [PATCH 010/260] Removing border radius on a white-on-white box. (#29) --- python_docs_theme/static/pydoctheme.css | 4 ---- 1 file changed, 4 deletions(-) diff --git a/python_docs_theme/static/pydoctheme.css b/python_docs_theme/static/pydoctheme.css index 2aa5bad9..33f74d79 100644 --- a/python_docs_theme/static/pydoctheme.css +++ b/python_docs_theme/static/pydoctheme.css @@ -133,10 +133,6 @@ div.body tt.xref, div.body a tt, div.body code.xref, div.body a code { font-weight: normal; } -.deprecated { - border-radius: 3px; -} - table.docutils { border: 1px solid #ddd; min-width: 20%; From fc9f203dd79587c8aed2b822cf7401518cd65bb5 Mon Sep 17 00:00:00 2001 From: Remi Rampin Date: Tue, 10 Dec 2019 18:01:02 -0500 Subject: [PATCH 011/260] Fix link to Sphinx (#34) --- python_docs_theme/layout.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python_docs_theme/layout.html b/python_docs_theme/layout.html index 822e6eda..4ad39cb8 100644 --- a/python_docs_theme/layout.html +++ b/python_docs_theme/layout.html @@ -55,6 +55,6 @@ {% if theme_issues_url %}{% trans pathto_bugs=theme_issues_url %}Found a bug?{% endtrans %}{% endif %}
- {% trans sphinx_version=sphinx_version|e %}Created using Sphinx {{ sphinx_version }}.{% endtrans %} + {% trans sphinx_version=sphinx_version|e %}Created using Sphinx {{ sphinx_version }}.{% endtrans %} {% endblock %} From e7367ebe35c3d6622d7e2bb01d7881e476eeadf0 Mon Sep 17 00:00:00 2001 From: Zachary Ware Date: Tue, 14 Jan 2020 14:07:43 -0600 Subject: [PATCH 012/260] Bump version for release (#38) --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 8e4a76c8..58cad187 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ name='python-docs-theme', # Version is date based as year.month[.serial], where serial is used # if multiple releases are needed to address build failures. - version='2018.7', + version='2020.1', description='The Sphinx theme for the CPython docs and related projects', long_description=long_description, author='PyPA', From 05e68881225f21ffce2a1d721e56e99f38d92efa Mon Sep 17 00:00:00 2001 From: Mariatta Date: Tue, 14 Jan 2020 19:59:16 -0800 Subject: [PATCH 013/260] post release version bump (#39) --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 58cad187..2e145d62 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ name='python-docs-theme', # Version is date based as year.month[.serial], where serial is used # if multiple releases are needed to address build failures. - version='2020.1', + version='2020.1.post1', description='The Sphinx theme for the CPython docs and related projects', long_description=long_description, author='PyPA', From 628a66466589ba42037d4aad3d676cb7d81fb6e6 Mon Sep 17 00:00:00 2001 From: Mariatta Date: Wed, 15 Jan 2020 06:38:03 -0800 Subject: [PATCH 014/260] Remind user about virtualenv and using python -m (#41) --- README.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 1ba79624..476a46c0 100644 --- a/README.rst +++ b/README.rst @@ -10,6 +10,14 @@ projects if you so choose, but please keep in mind that in doing so you're also choosing to accept some of the responsibility for maintaining that collective trust. -To use the theme, install it into your docs build environment via ``pip``:: +To use the theme, install it into your docs build environment via ``pip`` +(preferably in a virtual environment). - pip install python-docs-theme +1. Create and activate a virtual environment:: + + $ python -m venv env + $ source env/bin/activate + +2. Install python-docs-theme using `pip`:: + + (env)$ python -m pip install python-docs-theme From ffb755eeee8b8b7343965423e1918fac90d33949 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam <3275593+pradyunsg@users.noreply.github.com> Date: Wed, 29 Jul 2020 02:07:15 +0530 Subject: [PATCH 015/260] Use the GitHub Repository as url (#49) This provides more information on the PyPI page for the project, and makes it easier to reach this repository from the PyPI page. --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 2e145d62..a3c93ef6 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ long_description=long_description, author='PyPA', author_email='distutils-sig@python.org', - url='https://docs.python.org', + url='https://github.com/python/python-docs-theme/', packages=['python_docs_theme'], include_package_data=True, entry_points={ From dad145a2968348603856e32b18509e3b1f2b16ee Mon Sep 17 00:00:00 2001 From: Todd Date: Sat, 12 Sep 2020 14:01:24 -0400 Subject: [PATCH 016/260] Add license information to footer (#36) * add license information to footer * modify wording as requested --- python_docs_theme/layout.html | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/python_docs_theme/layout.html b/python_docs_theme/layout.html index 4ad39cb8..3d7d5086 100644 --- a/python_docs_theme/layout.html +++ b/python_docs_theme/layout.html @@ -47,6 +47,12 @@
© {% trans %}Copyright{% endtrans %} {{ copyright|e }}.
+ {% trans %}This page is licensed under the Python Software Fundation License Version 2.{% endtrans %} +
+ {% trans %}Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.{% endtrans %} +
+ {% trans pathto_license=license_file %}See History and License for more information.{% endtrans %} +

{% include "footerdonate.html" %}
From 5b12f0dcc382d4ded1d1ba914e99c4b8a80c82b6 Mon Sep 17 00:00:00 2001 From: Dominic Davis-Foster Date: Mon, 14 Sep 2020 12:17:32 +0100 Subject: [PATCH 017/260] Fix typo in footer. --- python_docs_theme/layout.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python_docs_theme/layout.html b/python_docs_theme/layout.html index 3d7d5086..c4a48fa6 100644 --- a/python_docs_theme/layout.html +++ b/python_docs_theme/layout.html @@ -47,7 +47,7 @@
© {% trans %}Copyright{% endtrans %} {{ copyright|e }}.
- {% trans %}This page is licensed under the Python Software Fundation License Version 2.{% endtrans %} + {% trans %}This page is licensed under the Python Software Foundation License Version 2.{% endtrans %}
{% trans %}Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.{% endtrans %}
From 3f9bad7ce0cc7dffe17e662b55fc0c7d9247f0de Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Mon, 14 Sep 2020 22:41:42 +0530 Subject: [PATCH 018/260] Add instructions for using the theme (#32) Fixes https://github.com/python/python-docs-theme/issues/16. Co-authored-by: Mariatta --- README.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 476a46c0..b934dd2a 100644 --- a/README.rst +++ b/README.rst @@ -13,11 +13,12 @@ trust. To use the theme, install it into your docs build environment via ``pip`` (preferably in a virtual environment). -1. Create and activate a virtual environment:: - $ python -m venv env - $ source env/bin/activate +Configuration options +--------------------- -2. Install python-docs-theme using `pip`:: - - (env)$ python -m pip install python-docs-theme +To use this theme, add the following to ``conf.py``:: + +- ``html_theme = 'python_docs_theme'`` + +- ``html_sidebars``, defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars From a0d0d8b2649ac9556f1d16b16aae17e05580813b Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Tue, 15 Sep 2020 17:28:21 +0300 Subject: [PATCH 019/260] Fix code formatting (#53) --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index b934dd2a..3f2e8443 100644 --- a/README.rst +++ b/README.rst @@ -17,7 +17,7 @@ To use the theme, install it into your docs build environment via ``pip`` Configuration options --------------------- -To use this theme, add the following to ``conf.py``:: +To use this theme, add the following to ``conf.py``: - ``html_theme = 'python_docs_theme'`` From 197546f400fd1164a87ea20e35c0fcbe331661cb Mon Sep 17 00:00:00 2001 From: Zhiming Wang Date: Sat, 10 Oct 2020 11:09:49 +0800 Subject: [PATCH 020/260] Fix codebgcolor and codetextcolor for Sphinx 3.1.0+ Sphinx 3.1.0+ dropped the custom codebgcolor and codetextcolor from the classic theme[1], leaving pre elements uncolored. [1] https://github.com/sphinx-doc/sphinx/commit/b345acc2840a792162845e3a1a3456c347fac08e --- python_docs_theme/theme.conf | 2 ++ 1 file changed, 2 insertions(+) diff --git a/python_docs_theme/theme.conf b/python_docs_theme/theme.conf index 22762ecf..bffa8c1c 100644 --- a/python_docs_theme/theme.conf +++ b/python_docs_theme/theme.conf @@ -21,6 +21,8 @@ visitedlinkcolor = #00608f headtextcolor = #1a1a1a headbgcolor = white headlinkcolor = #aaaaaa +codebgcolor = #eeffcc +codetextcolor = #333333 issues_url = root_name = Python From 05a7cacdd2c508bdc15a41c98ecc026f177900a4 Mon Sep 17 00:00:00 2001 From: Mariatta Date: Mon, 21 Dec 2020 16:37:32 -0800 Subject: [PATCH 021/260] Release v 2020.12 (#60) Released at https://pypi.org/project/python-docs-theme/2020.12/ Changelog: https://github.com/python/python-docs-theme/releases/tag/v2020.12 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index a3c93ef6..8f6606f4 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ name='python-docs-theme', # Version is date based as year.month[.serial], where serial is used # if multiple releases are needed to address build failures. - version='2020.1.post1', + version='2020.12', description='The Sphinx theme for the CPython docs and related projects', long_description=long_description, author='PyPA', From c7c7b4014d620b4d6ad69d12f41bf2bbca454b08 Mon Sep 17 00:00:00 2001 From: Mariatta Date: Mon, 21 Dec 2020 16:40:10 -0800 Subject: [PATCH 022/260] Set the version to 2020.12.post1 (#61) --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 8f6606f4..0378da7e 100644 --- a/setup.py +++ b/setup.py @@ -13,7 +13,7 @@ name='python-docs-theme', # Version is date based as year.month[.serial], where serial is used # if multiple releases are needed to address build failures. - version='2020.12', + version='2020.12.post1', description='The Sphinx theme for the CPython docs and related projects', long_description=long_description, author='PyPA', From 0f18f099351a91b8357c5551c5b5355f238d27d1 Mon Sep 17 00:00:00 2001 From: Julien Palard Date: Thu, 4 Mar 2021 22:52:20 +0100 Subject: [PATCH 023/260] Add the copy button to pycon3 highlighted code blocks. (#64) --- python_docs_theme/static/copybutton.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python_docs_theme/static/copybutton.js b/python_docs_theme/static/copybutton.js index f5960d26..16dee005 100644 --- a/python_docs_theme/static/copybutton.js +++ b/python_docs_theme/static/copybutton.js @@ -5,6 +5,7 @@ $(document).ready(function() { var div = $('.highlight-python .highlight,' + '.highlight-python3 .highlight,' + '.highlight-pycon .highlight,' + + '.highlight-pycon3 .highlight,' + '.highlight-default .highlight'); var pre = div.find('pre'); @@ -61,4 +62,3 @@ $(document).ready(function() { } }); }); - From 6d56e320fa5fb754a37dc39a6db1a1071ceeb00a Mon Sep 17 00:00:00 2001 From: Julien Palard Date: Tue, 13 Apr 2021 23:16:07 +0200 Subject: [PATCH 024/260] Test Github action to validate the theme against docsbuild scripts. (#69) --- .github/workflows/tests.yml | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/workflows/tests.yml diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 00000000..0462f5e8 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,34 @@ +name: Tests + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + build_doc: + name: 'Build cpython doc' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: 3.7 + - name: clone docsbuild scripts + run: | + git clone https://github.com/python/docsbuild-scripts/ + - name: setup requirements + run: | + python -m pip install --upgrade pip + python -m pip install jinja2 markupsafe + - name: build docs + run: | + python3 ./docsbuild-scripts/build_docs.py --quick --build-root ./build_root --www-root ./www --log-directory ./logs --group $(id -g) --skip-cache-invalidation --theme $(pwd) --language en --branch 3.9 + - name: 'Upload' + uses: actions/upload-artifact@v2.2.2 + with: + name: doc-html + path: www/ From 55864868d933d26fdb1bb2ccabba01f44ebba011 Mon Sep 17 00:00:00 2001 From: Aaron Carlisle Date: Sat, 1 May 2021 06:20:29 -0400 Subject: [PATCH 025/260] Use default pygments theme (#68) The default theme looks a lot better than the default theme with the green background. --- python_docs_theme/theme.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python_docs_theme/theme.conf b/python_docs_theme/theme.conf index bffa8c1c..ac8f097c 100644 --- a/python_docs_theme/theme.conf +++ b/python_docs_theme/theme.conf @@ -1,7 +1,7 @@ [theme] inherit = default stylesheet = pydoctheme.css -pygments_style = sphinx +pygments_style = default [options] bodyfont = 'Lucida Grande', Arial, sans-serif From 6892a232093ce2a6374eefebaf9a891f021560eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Wirtel?= Date: Wed, 5 May 2021 17:08:45 +0200 Subject: [PATCH 026/260] Use Python 3.8 for the Github Actions (#71) --- .github/workflows/tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 0462f5e8..4fbd65c7 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -16,7 +16,7 @@ jobs: - uses: actions/checkout@v2 - uses: actions/setup-python@v2 with: - python-version: 3.7 + python-version: 3.8 - name: clone docsbuild scripts run: | git clone https://github.com/python/docsbuild-scripts/ From 844973206b71948abd113ea0ec24a9955ea1d6aa Mon Sep 17 00:00:00 2001 From: Olga Bulat Date: Fri, 7 May 2021 10:25:26 +0300 Subject: [PATCH 027/260] Make the theme responsive (#46) --- python_docs_theme/layout.html | 121 ++++++++-- python_docs_theme/static/caret-down.svg | 1 + python_docs_theme/static/menu.js | 55 +++++ python_docs_theme/static/py.svg | 14 ++ python_docs_theme/static/pydoctheme.css | 305 +++++++++++++++++++++++- python_docs_theme/theme.conf | 2 +- 6 files changed, 470 insertions(+), 28 deletions(-) create mode 100644 python_docs_theme/static/caret-down.svg create mode 100644 python_docs_theme/static/menu.js create mode 100644 python_docs_theme/static/py.svg diff --git a/python_docs_theme/layout.html b/python_docs_theme/layout.html index c4a48fa6..8a0d65d4 100644 --- a/python_docs_theme/layout.html +++ b/python_docs_theme/layout.html @@ -1,46 +1,121 @@ {% extends "classic/layout.html" %} -{% block rootrellink %} -
    • -
  • {{theme_root_name}}{{ reldelim1 }}
    • - {% if theme_root_include_title %} - {{ shorttitle }}{{ reldelim1 }} - {% endif %} -{% endblock %} +{%- macro relbar() %} +{# modified from sphinx/themes/basic/layout.html #} + +{%- endmacro %} {%- macro searchbox() %} {# modified from sphinx/themes/basic/searchbox.html #} {%- if builder != "htmlhelp" %} - @@ -59,16 +60,6 @@

    {{ _('Navigation') }}

    {% block relbar1 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %} {% block relbar2 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %} -{% block relbaritems %} -{%- if pagename != "search" and builder != "singlehtml" and builder != "htmlhelp" %} -
  • - {{ searchbox() }} - {{ reldelim2 }} -
    • -{%- endif %} -
  • {{ reldelim2 }}
    • -{% endblock %} - {%- block extrahead -%} diff --git a/python_docs_theme/static/pydoctheme.css b/python_docs_theme/static/pydoctheme.css index 21be22c6..18ad6108 100644 --- a/python_docs_theme/static/pydoctheme.css +++ b/python_docs_theme/static/pydoctheme.css @@ -34,24 +34,23 @@ body { } div.related { + margin-top: 0.5em; margin-bottom: 1.2em; padding: 0.5em 0; - border-top: 1px solid #ccc; - margin-top: 0.5em; + border-width: 1px; + border-color: #ccc; } -div.related a:hover { - color: #0095c4; +.mobile-nav + div.related { + border-bottom-style: solid; } -div.related ~ div.related { - border-top: 1px solid #ccc; - border-bottom: none; +.document + div.related { + border-top-style: solid; } -div.related:first-child { - border-top: 0; - border-bottom: 1px solid #ccc; +div.related a:hover { + color: #0095c4; } .related .switchers { @@ -62,13 +61,6 @@ div.related:first-child { margin-right: 5px; } -.version_switcher_placeholder, -.language_switcher_placeholder { - padding-left: 5px; - background-color: white; -} - - div.related ul::after { content: ''; clear: both; diff --git a/python_docs_theme/static/pydoctheme_dark.css b/python_docs_theme/static/pydoctheme_dark.css index d263f949..c1016878 100644 --- a/python_docs_theme/static/pydoctheme_dark.css +++ b/python_docs_theme/static/pydoctheme_dark.css @@ -13,12 +13,7 @@ body { div.related { color: rgba(255, 255, 255, 0.7); /* classic overwrite */ - border-top-color: #424242; -} - -div.related:first-child { - /* use :first-child because border-color would need !important */ - border-bottom-color: #424242; + border-color: #424242; } /* SIDEBAR */ From dd5772236307153b1361b0e825f329cebe8df65d Mon Sep 17 00:00:00 2001 From: Septatrix <24257556+Septatrix@users.noreply.github.com> Date: Mon, 10 May 2021 16:38:16 +0200 Subject: [PATCH 061/260] Adjust to responsive changes --- python_docs_theme/static/pydoctheme.css | 16 ++++++++-------- python_docs_theme/static/pydoctheme_dark.css | 6 +++++- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/python_docs_theme/static/pydoctheme.css b/python_docs_theme/static/pydoctheme.css index 18ad6108..69a59df7 100644 --- a/python_docs_theme/static/pydoctheme.css +++ b/python_docs_theme/static/pydoctheme.css @@ -16,6 +16,12 @@ div.sphinxsidebar ul, div.sphinxsidebar h3, div.sphinxsidebar h3 a, div.sphinxsidebar h4, +.menu a, +.menu p, +.menu ul, +.menu h3, +.menu h3 a, +.menu h4, table.docutils td, table.indextable tr.cap, pre { @@ -213,6 +219,7 @@ table.docutils td, table.docutils th { border: 1px solid #ddd !important; border-radius: 3px; + padding: 0.3em 0.5em; } table p, @@ -222,12 +229,6 @@ table li { table.docutils th { background-color: #eee; - padding: 0.3em 0.5em; -} - -table.docutils td { - background-color: white; - padding: 0.3em 0.5em; } table.footnote, @@ -465,6 +466,7 @@ dl > dt span ~ em { width: 300px; height: 100%; background-color: #eee; + color: #444444; box-shadow: 0 0 10px rgba(0, 0, 0, 0.2); overflow-y: auto; } @@ -484,7 +486,6 @@ dl > dt span ~ em { font-size: 1.3em; } .menu-wrapper h3 { - color: #444444; font-size: 1.4em; } .menu-wrapper h3 + p, @@ -493,7 +494,6 @@ dl > dt span ~ em { } .menu a { font-size: smaller; - color: #444444; text-decoration: none; } .menu ul { diff --git a/python_docs_theme/static/pydoctheme_dark.css b/python_docs_theme/static/pydoctheme_dark.css index c1016878..2d574ad0 100644 --- a/python_docs_theme/static/pydoctheme_dark.css +++ b/python_docs_theme/static/pydoctheme_dark.css @@ -17,7 +17,7 @@ div.related { } /* SIDEBAR */ -div.sphinxsidebar { +div.sphinxsidebar, .menu-wrapper { background-color: #333; color: inherit; } @@ -112,3 +112,7 @@ div.note { .note code { background-color: rgba(255, 255, 255, 0.1); } + +.mobile-nav { + box-shadow: rgba(255, 255, 255, 0.25) 0 0 2px 0; +} \ No newline at end of file From 3bf3806b1f829b29ed5664b6772c1e9d163f270c Mon Sep 17 00:00:00 2001 From: Septatrix <24257556+Septatrix@users.noreply.github.com> Date: Fri, 18 Nov 2022 22:31:44 +0200 Subject: [PATCH 062/260] Fix more bugs with the new mobile view --- python_docs_theme/layout.html | 50 +++++++----- python_docs_theme/static/caret-down.svg | 1 - python_docs_theme/static/pydoctheme.css | 85 ++++++++++---------- python_docs_theme/static/pydoctheme_dark.css | 8 ++ python_docs_theme/static/themetoggle.js | 31 ++----- 5 files changed, 89 insertions(+), 86 deletions(-) delete mode 100644 python_docs_theme/static/caret-down.svg diff --git a/python_docs_theme/layout.html b/python_docs_theme/layout.html index f05f1660..3b284971 100644 --- a/python_docs_theme/layout.html +++ b/python_docs_theme/layout.html @@ -37,7 +37,7 @@

    {{ _('Navigation') }}

    {{ reldelim2 }} {%- endif %} -
  • {{ reldelim2 }}
    • +
  • {{ themeselector() }}{{ reldelim2 }}
    • {% endblock %}
    @@ -57,6 +57,17 @@

    {{ _('Navigation') }}

    {%- endif %} {%- endmacro %} +{%- macro themeselector() %} + +{%- endmacro %} + {% block relbar1 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %} {% block relbar2 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %} @@ -84,28 +95,31 @@

    {{ _('Navigation') }}

    -