From 110e00bde022618c27ec47179d51f028b65c5da1 Mon Sep 17 00:00:00 2001 From: JinWang An Date: Mon, 27 Mar 2023 17:02:34 +0900 Subject: [PATCH] Imported Upstream version 57.3.0 --- .bumpversion.cfg | 2 +- .github/workflows/main.yml | 1 + CHANGES.rst | 9 + docs/_templates/indexsidebar.html | 15 -- docs/_templates/tidelift-sidebar.html | 6 - docs/_theme/nature/static/nature.css_t | 237 ----------------------- docs/_theme/nature/static/pygments.css | 54 ------ docs/_theme/nature/theme.conf | 4 - docs/conf.py | 8 +- docs/deprecated/easy_install.rst | 3 - docs/deprecated/python_eggs.rst | 4 - docs/development/developer-guide.rst | 5 +- docs/index.rst | 9 +- docs/pkg_resources.rst | 3 - docs/setuptools.rst | 3 - docs/userguide/dependency_management.rst | 2 - docs/userguide/quickstart.rst | 2 - setup.cfg | 4 +- tox.ini | 18 -- 19 files changed, 24 insertions(+), 365 deletions(-) delete mode 100644 docs/_templates/indexsidebar.html delete mode 100644 docs/_templates/tidelift-sidebar.html delete mode 100644 docs/_theme/nature/static/nature.css_t delete mode 100644 docs/_theme/nature/static/pygments.css delete mode 100644 docs/_theme/nature/theme.conf diff --git a/.bumpversion.cfg b/.bumpversion.cfg index ac2e2b6..6c93847 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 57.2.0 +current_version = 57.3.0 commit = True tag = True diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index c0916fa..6af3ac7 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -25,6 +25,7 @@ jobs: - name: Run tests run: tox -- --cov-report xml - name: Publish coverage + if: false # disabled for #2727 uses: codecov/codecov-action@v1 with: flags: >- # Mark which lines are covered by which envs diff --git a/CHANGES.rst b/CHANGES.rst index ba4a5fb..fde2da1 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,3 +1,12 @@ +v57.3.0 +------- + + +Changes +^^^^^^^ +* #2465: Documentation is now published using the Furo theme. + + v57.2.0 ------- diff --git a/docs/_templates/indexsidebar.html b/docs/_templates/indexsidebar.html deleted file mode 100644 index d803b8a..0000000 --- a/docs/_templates/indexsidebar.html +++ /dev/null @@ -1,15 +0,0 @@ -

For Enterprise

- -

-Professionally-supported {{ project }} is available with the -Tidelift Subscription. -

- -

Download

- -

Current version: {{ version }}

-

Get Setuptools from the Python Package Index - -

Questions? Suggestions? Contributions?

- -

Visit the Project page

diff --git a/docs/_templates/tidelift-sidebar.html b/docs/_templates/tidelift-sidebar.html deleted file mode 100644 index ce48f46..0000000 --- a/docs/_templates/tidelift-sidebar.html +++ /dev/null @@ -1,6 +0,0 @@ -

For Enterprise

- -

-Professionally-supported {{ project }} is available with the -Tidelift Subscription. -

diff --git a/docs/_theme/nature/static/nature.css_t b/docs/_theme/nature/static/nature.css_t deleted file mode 100644 index 1a65426..0000000 --- a/docs/_theme/nature/static/nature.css_t +++ /dev/null @@ -1,237 +0,0 @@ -/** - * Sphinx stylesheet -- default theme - * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - */ - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: Arial, sans-serif; - font-size: 100%; - background-color: #111111; - color: #555555; - margin: 0; - padding: 0; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 300px; -} - -hr{ - border: 1px solid #B1B4B6; -} - -div.document { - background-color: #fafafa; -} - -div.body { - background-color: #ffffff; - color: #3E4349; - padding: 1em 30px 30px 30px; - font-size: 0.9em; -} - -div.footer { - color: #555; - width: 100%; - padding: 13px 0; - text-align: center; - font-size: 75%; -} - -div.footer a { - color: #444444; -} - -div.related { - background-color: #6BA81E; - line-height: 36px; - color: #ffffff; - text-shadow: 0px 1px 0 #444444; - font-size: 1.1em; -} - -div.related a { - color: #E2F3CC; -} - -div.related .right { - font-size: 0.9em; -} - -div.sphinxsidebar { - font-size: 0.9em; - line-height: 1.5em; - width: 300px; -} - -div.sphinxsidebarwrapper{ - padding: 20px 0; -} - -div.sphinxsidebar h3, -div.sphinxsidebar h4 { - font-family: Arial, sans-serif; - color: #222222; - font-size: 1.2em; - font-weight: bold; - margin: 0; - padding: 5px 10px; - text-shadow: 1px 1px 0 white -} - -div.sphinxsidebar h3 a { - color: #444444; -} - -div.sphinxsidebar p { - color: #888888; - padding: 5px 20px; - margin: 0.5em 0px; -} - -div.sphinxsidebar p.topless { -} - -div.sphinxsidebar ul { - margin: 10px 10px 10px 20px; - padding: 0; - color: #000000; -} - -div.sphinxsidebar a { - color: #444444; -} - -div.sphinxsidebar a:hover { - color: #E32E00; -} - -div.sphinxsidebar input { - border: 1px solid #cccccc; - font-family: sans-serif; - font-size: 1.1em; - padding: 0.15em 0.3em; -} - -div.sphinxsidebar input[type=text]{ - margin-left: 20px; -} - -/* -- body styles ----------------------------------------------------------- */ - -a { - color: #005B81; - text-decoration: none; -} - -a:hover { - color: #E32E00; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: Arial, sans-serif; - font-weight: normal; - color: #212224; - margin: 30px 0px 10px 0px; - padding: 5px 0 5px 0px; - text-shadow: 0px 1px 0 white; - border-bottom: 1px solid #C8D5E3; -} - -div.body h1 { margin-top: 0; font-size: 200%; } -div.body h2 { font-size: 150%; } -div.body h3 { font-size: 120%; } -div.body h4 { font-size: 110%; } -div.body h5 { font-size: 100%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #c60f0f; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: #c60f0f; - color: white; -} - -div.body p, div.body dd, div.body li { - line-height: 1.8em; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.highlight{ - background-color: white; -} - -div.note { - background-color: #eeeeee; - border: 1px solid #cccccc; -} - -div.seealso { - background-color: #ffffcc; - border: 1px solid #ffff66; -} - -div.topic { - background-color: #fafafa; - border-width: 0; -} - -div.warning { - background-color: #ffe4e4; - border: 1px solid #ff6666; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre { - padding: 10px; - background-color: #fafafa; - color: #222222; - line-height: 1.5em; - font-size: 1.1em; - margin: 1.5em 0 1.5em 0; - -webkit-box-shadow: 0px 0px 4px #d8d8d8; - -moz-box-shadow: 0px 0px 4px #d8d8d8; - box-shadow: 0px 0px 4px #d8d8d8; -} - -tt { - color: #222222; - padding: 1px 2px; - font-size: 1.2em; - font-family: monospace; -} - -#table-of-contents ul { - padding-left: 2em; -} - diff --git a/docs/_theme/nature/static/pygments.css b/docs/_theme/nature/static/pygments.css deleted file mode 100644 index 652b761..0000000 --- a/docs/_theme/nature/static/pygments.css +++ /dev/null @@ -1,54 +0,0 @@ -.c { color: #999988; font-style: italic } /* Comment */ -.k { font-weight: bold } /* Keyword */ -.o { font-weight: bold } /* Operator */ -.cm { color: #999988; font-style: italic } /* Comment.Multiline */ -.cp { color: #999999; font-weight: bold } /* Comment.preproc */ -.c1 { color: #999988; font-style: italic } /* Comment.Single */ -.gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ -.ge { font-style: italic } /* Generic.Emph */ -.gr { color: #aa0000 } /* Generic.Error */ -.gh { color: #999999 } /* Generic.Heading */ -.gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ -.go { color: #111 } /* Generic.Output */ -.gp { color: #555555 } /* Generic.Prompt */ -.gs { font-weight: bold } /* Generic.Strong */ -.gu { color: #aaaaaa } /* Generic.Subheading */ -.gt { color: #aa0000 } /* Generic.Traceback */ -.kc { font-weight: bold } /* Keyword.Constant */ -.kd { font-weight: bold } /* Keyword.Declaration */ -.kp { font-weight: bold } /* Keyword.Pseudo */ -.kr { font-weight: bold } /* Keyword.Reserved */ -.kt { color: #445588; font-weight: bold } /* Keyword.Type */ -.m { color: #009999 } /* Literal.Number */ -.s { color: #bb8844 } /* Literal.String */ -.na { color: #008080 } /* Name.Attribute */ -.nb { color: #999999 } /* Name.Builtin */ -.nc { color: #445588; font-weight: bold } /* Name.Class */ -.no { color: #ff99ff } /* Name.Constant */ -.ni { color: #800080 } /* Name.Entity */ -.ne { color: #990000; font-weight: bold } /* Name.Exception */ -.nf { color: #990000; font-weight: bold } /* Name.Function */ -.nn { color: #555555 } /* Name.Namespace */ -.nt { color: #000080 } /* Name.Tag */ -.nv { color: purple } /* Name.Variable */ -.ow { font-weight: bold } /* Operator.Word */ -.mf { color: #009999 } /* Literal.Number.Float */ -.mh { color: #009999 } /* Literal.Number.Hex */ -.mi { color: #009999 } /* Literal.Number.Integer */ -.mo { color: #009999 } /* Literal.Number.Oct */ -.sb { color: #bb8844 } /* Literal.String.Backtick */ -.sc { color: #bb8844 } /* Literal.String.Char */ -.sd { color: #bb8844 } /* Literal.String.Doc */ -.s2 { color: #bb8844 } /* Literal.String.Double */ -.se { color: #bb8844 } /* Literal.String.Escape */ -.sh { color: #bb8844 } /* Literal.String.Heredoc */ -.si { color: #bb8844 } /* Literal.String.Interpol */ -.sx { color: #bb8844 } /* Literal.String.Other */ -.sr { color: #808000 } /* Literal.String.Regex */ -.s1 { color: #bb8844 } /* Literal.String.Single */ -.ss { color: #bb8844 } /* Literal.String.Symbol */ -.bp { color: #999999 } /* Name.Builtin.Pseudo */ -.vc { color: #ff99ff } /* Name.Variable.Class */ -.vg { color: #ff99ff } /* Name.Variable.Global */ -.vi { color: #ff99ff } /* Name.Variable.Instance */ -.il { color: #009999 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/_theme/nature/theme.conf b/docs/_theme/nature/theme.conf deleted file mode 100644 index 1cc4004..0000000 --- a/docs/_theme/nature/theme.conf +++ /dev/null @@ -1,4 +0,0 @@ -[theme] -inherit = basic -stylesheet = nature.css -pygments_style = tango diff --git a/docs/conf.py b/docs/conf.py index 4548cf2..8f1e1f4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -92,10 +92,8 @@ extensions += ['sphinx.ext.extlinks', 'sphinx.ext.intersphinx'] # #diff-85987f48f1258d9ee486e3191495582dR82 default_role = 'any' -# Custom sidebar templates, maps document names to template names. -html_theme = 'alabaster' -templates_path = ['_templates'] -html_sidebars = {'index': ['tidelift-sidebar.html']} +# HTML theme +html_theme = 'furo' # Add support for inline tabs extensions += ['sphinx_inline_tabs'] @@ -150,3 +148,5 @@ extensions += ['sphinxcontrib.towncrier'] towncrier_draft_working_directory = '..' # Avoid an empty section for unpublished changes. towncrier_draft_include_empty = False + +extensions += ['jaraco.tidelift'] diff --git a/docs/deprecated/easy_install.rst b/docs/deprecated/easy_install.rst index fac7b8f..76c3f60 100644 --- a/docs/deprecated/easy_install.rst +++ b/docs/deprecated/easy_install.rst @@ -25,9 +25,6 @@ own packages work better with EasyInstall, or provide EasyInstall-like features without requiring your users to use EasyInstall directly, you'll probably want to check out the full documentation as well.) -.. contents:: **Table of Contents** - - Using "Easy Install" ==================== diff --git a/docs/deprecated/python_eggs.rst b/docs/deprecated/python_eggs.rst index 6c0456d..59d1adc 100644 --- a/docs/deprecated/python_eggs.rst +++ b/docs/deprecated/python_eggs.rst @@ -6,9 +6,6 @@ STOP! This is not the first document you should read! -.. contents:: **Table of Contents** - - ---------------------- Eggs and their Formats ---------------------- @@ -676,4 +673,3 @@ to facilitate introspection of installed scripts, and their relationship to installed eggs. For example, an uninstallation tool could use this data to identify what scripts can safely be removed, and/or identify what scripts would stop working if a particular egg is uninstalled. - diff --git a/docs/development/developer-guide.rst b/docs/development/developer-guide.rst index 13b07e7..d6ed2c1 100644 --- a/docs/development/developer-guide.rst +++ b/docs/development/developer-guide.rst @@ -5,9 +5,6 @@ Developer's Guide for Setuptools If you want to know more about contributing on Setuptools, this is the place. -.. contents:: **Table of Contents** - - ------------------- Recommended Reading ------------------- @@ -61,7 +58,7 @@ jump to the in-depth discussion about any subject referenced. Making a pull request --------------------- -When making a pull request, please +When making a pull request, please :ref:`include a short summary of the changes ` and a reference to any issue tickets that the PR is intended to solve. diff --git a/docs/index.rst b/docs/index.rst index b9a7964..2833ab9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,13 +1,12 @@ -Documentation -============= +setuptools +========== Setuptools is a fully-featured, actively-maintained, and stable library designed to facilitate packaging Python projects. -Documentation content: - .. toctree:: :maxdepth: 1 + :hidden: User guide build_meta @@ -18,3 +17,5 @@ Documentation content: Development guide Backward compatibility & deprecated practice Changelog + +.. tidelift-referral-banner:: diff --git a/docs/pkg_resources.rst b/docs/pkg_resources.rst index 2ba1013..fb5fc07 100644 --- a/docs/pkg_resources.rst +++ b/docs/pkg_resources.rst @@ -18,9 +18,6 @@ and their backports (`resources `_ Please consider using those libraries instead of pkg_resources. -.. contents:: **Table of Contents** - - -------- Overview -------- diff --git a/docs/setuptools.rst b/docs/setuptools.rst index 541bec5..1440016 100644 --- a/docs/setuptools.rst +++ b/docs/setuptools.rst @@ -47,9 +47,6 @@ Feature Highlights: * Full support for PEP 420 via ``find_namespace_packages()``, which is also backwards compatible to the existing ``find_packages()`` for Python >= 3.3. -.. contents:: **Table of Contents** - - ----------------- Developer's Guide ----------------- diff --git a/docs/userguide/dependency_management.rst b/docs/userguide/dependency_management.rst index c6333a1..1c61079 100644 --- a/docs/userguide/dependency_management.rst +++ b/docs/userguide/dependency_management.rst @@ -11,8 +11,6 @@ dependency. version by following `PEP 440 `_ -.. contents:: - Build system requirement ======================== diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 68e0443..1bd04de 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -2,8 +2,6 @@ ``setuptools`` Quickstart ========================== -.. contents:: - Installation ============ diff --git a/setup.cfg b/setup.cfg index ebb42e4..ef6d763 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,7 +2,7 @@ license_files = LICENSE name = setuptools -version = 57.2.0 +version = 57.3.0 author = Python Packaging Authority author_email = distutils-sig@python.org description = Easily download, build, install, upgrade, and uninstall Python packages @@ -71,11 +71,13 @@ docs = sphinx jaraco.packaging >= 8.2 rst.linker >= 1.9 + jaraco.tidelift >= 1.4 # local pygments-github-lexers==0.0.5 sphinx-inline-tabs sphinxcontrib-towncrier + furo ssl = diff --git a/tox.ini b/tox.ini index a1b3c16..28ff16a 100644 --- a/tox.ini +++ b/tox.ini @@ -11,27 +11,9 @@ commands = pytest {posargs} usedevelop = True extras = testing -setenv = - COVERAGE_FILE={toxworkdir}/.coverage.{envname} passenv = windir # required for test_pkg_resources -[testenv:coverage] -description=Combine coverage data and create report -deps=coverage -skip_install=True -changedir={toxworkdir} -setenv=COVERAGE_FILE=.coverage -commands=coverage erase - coverage combine - coverage {posargs:xml} - -[testenv:codecov] -description=[Only run on CI]: Upload coverage data to codecov -deps=codecov -skip_install=True -commands=codecov -X gcov --file {toxworkdir}/coverage.xml - [testenv:docs] extras = docs -- 2.34.1