From ced789b6ba306e58dc615176478ac598e58994e3 Mon Sep 17 00:00:00 2001 From: Andrey Otto Date: Tue, 5 Nov 2024 11:20:18 +0700 Subject: [PATCH] Replace sphinx-rtd-theme by furo --- HISTORY.rst | 20 +++++++----- docs/api_drf.rst | 2 +- docs/conf.py | 4 +-- poetry.lock | 85 +++++++++++++++++++++++++++++++++--------------- pyproject.toml | 4 +-- 5 files changed, 76 insertions(+), 39 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index 23e72f5..64474ec 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -2,18 +2,22 @@ History ======= -0.7.0 (2024-10-29) +UNRELEASED ---------- +* Replaced `sphinx-rtd-theme` by [furo](https://github.com/pradyunsg/furo) + +0.7.0 (2024-10-29) +------------------ * Add support django-import-export >= 4.2 * Removed support for django-import-export < 4.2 * Improve test coverage 0.6.1 (2024-10-04) ----------- +------------------ * Update requirements version and internal naming 0.6.0 (2024-10-04) ----------- +------------------ * Extend response of import job api * Added support for django-import-export >= 4.0 * Removed support for django 3.2 @@ -55,11 +59,11 @@ History * Use admin/import_export/ templates instead of copies in admin/import_export_extensions/ * Small improvements: - * Fix static folder name - * Fix invoke command to run celery - * Fix progress bar widget - * Rename filter_class to filterset_class - * Add cancel_job action for exporting + * Fix static folder name + * Fix invoke command to run celery + * Fix progress bar widget + * Rename filter_class to filterset_class + * Add cancel_job action for exporting 0.1.4 (2023-05-22) ------------------ diff --git a/docs/api_drf.rst b/docs/api_drf.rst index 3763d29..183608a 100644 --- a/docs/api_drf.rst +++ b/docs/api_drf.rst @@ -27,7 +27,7 @@ API (Rest Framework) :type: ProgressInfoSerializer :value: {"current": 0, "total": 0} - Shows current and total imported/exported values + Shows current and total imported/exported values .. autoclass:: import_export_extensions.api.ProgressInfoSerializer :members: diff --git a/docs/conf.py b/docs/conf.py index eac50ef..6dfb8ca 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,7 +35,7 @@ # General information about the project. project = "django-import-export-extensions" -copyright = "2022-2023, Saritasa" +copyright = "2022-2024, Saritasa" author = "Saritasa" # The language for content autogenerated by Sphinx. Refer to documentation @@ -62,7 +62,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "sphinx_rtd_theme" +html_theme = "furo" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/poetry.lock b/poetry.lock index f03c2ac..3f20754 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.4 and should not be changed by hand. [[package]] name = "alabaster" @@ -104,6 +104,27 @@ files = [ [package.extras] dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"] +[[package]] +name = "beautifulsoup4" +version = "4.12.3" +description = "Screen-scraping library" +optional = false +python-versions = ">=3.6.0" +files = [ + {file = "beautifulsoup4-4.12.3-py3-none-any.whl", hash = "sha256:b80878c9f40111313e55da8ba20bdba06d8fa3969fc68304167741bbf9e082ed"}, + {file = "beautifulsoup4-4.12.3.tar.gz", hash = "sha256:74e3d1928edc070d21748185c46e3fb33490f22f52a3addee9aee0f4f7781051"}, +] + +[package.dependencies] +soupsieve = ">1.2" + +[package.extras] +cchardet = ["cchardet"] +chardet = ["chardet"] +charset-normalizer = ["charset-normalizer"] +html5lib = ["html5lib"] +lxml = ["lxml"] + [[package]] name = "billiard" version = "4.2.1" @@ -751,6 +772,23 @@ docs = ["furo (>=2024.8.6)", "sphinx (>=8.0.2)", "sphinx-autodoc-typehints (>=2. testing = ["covdefaults (>=2.3)", "coverage (>=7.6.1)", "diff-cover (>=9.2)", "pytest (>=8.3.3)", "pytest-asyncio (>=0.24)", "pytest-cov (>=5)", "pytest-mock (>=3.14)", "pytest-timeout (>=2.3.1)", "virtualenv (>=20.26.4)"] typing = ["typing-extensions (>=4.12.2)"] +[[package]] +name = "furo" +version = "2024.8.6" +description = "A clean customisable Sphinx documentation theme." +optional = false +python-versions = ">=3.8" +files = [ + {file = "furo-2024.8.6-py3-none-any.whl", hash = "sha256:6cd97c58b47813d3619e63e9081169880fbe331f0ca883c871ff1f3f11814f5c"}, + {file = "furo-2024.8.6.tar.gz", hash = "sha256:b63e4cee8abfc3136d3bc03a3d45a76a850bada4d6374d24c1716b0e01394a01"}, +] + +[package.dependencies] +beautifulsoup4 = "*" +pygments = ">=2.7" +sphinx = ">=6.0,<9.0" +sphinx-basic-ng = ">=1.0.0.beta2" + [[package]] name = "identify" version = "2.6.1" @@ -1797,6 +1835,17 @@ files = [ {file = "snowballstemmer-2.2.0.tar.gz", hash = "sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1"}, ] +[[package]] +name = "soupsieve" +version = "2.6" +description = "A modern CSS selector implementation for Beautiful Soup." +optional = false +python-versions = ">=3.8" +files = [ + {file = "soupsieve-2.6-py3-none-any.whl", hash = "sha256:e72c4ff06e4fb6e4b5a9f0f55fe6e81514581fca1515028625d0f299c602ccc9"}, + {file = "soupsieve-2.6.tar.gz", hash = "sha256:e2e68417777af359ec65daac1057404a3c8a5455bb8abc36f1a9866ab1a51abb"}, +] + [[package]] name = "sphinx" version = "8.1.3" @@ -1833,23 +1882,21 @@ lint = ["flake8 (>=6.0)", "mypy (==1.11.1)", "pyright (==1.1.384)", "pytest (>=6 test = ["cython (>=3.0)", "defusedxml (>=0.7.1)", "pytest (>=8.0)", "setuptools (>=70.0)", "typing_extensions (>=4.9)"] [[package]] -name = "sphinx-rtd-theme" -version = "3.0.1" -description = "Read the Docs theme for Sphinx" +name = "sphinx-basic-ng" +version = "1.0.0b2" +description = "A modern skeleton for Sphinx themes." optional = false -python-versions = ">=3.8" +python-versions = ">=3.7" files = [ - {file = "sphinx_rtd_theme-3.0.1-py2.py3-none-any.whl", hash = "sha256:921c0ece75e90633ee876bd7b148cfaad136b481907ad154ac3669b6fc957916"}, - {file = "sphinx_rtd_theme-3.0.1.tar.gz", hash = "sha256:a4c5745d1b06dfcb80b7704fe532eb765b44065a8fad9851e4258c8804140703"}, + {file = "sphinx_basic_ng-1.0.0b2-py3-none-any.whl", hash = "sha256:eb09aedbabfb650607e9b4b68c9d240b90b1e1be221d6ad71d61c52e29f7932b"}, + {file = "sphinx_basic_ng-1.0.0b2.tar.gz", hash = "sha256:9ec55a47c90c8c002b5960c57492ec3021f5193cb26cebc2dc4ea226848651c9"}, ] [package.dependencies] -docutils = ">0.18,<0.22" -sphinx = ">=6,<9" -sphinxcontrib-jquery = ">=4,<5" +sphinx = ">=4.0" [package.extras] -dev = ["bump2version", "transifex-client", "twine", "wheel"] +docs = ["furo", "ipython", "myst-parser", "sphinx-copybutton", "sphinx-inline-tabs"] [[package]] name = "sphinxcontrib-applehelp" @@ -1899,20 +1946,6 @@ lint = ["mypy", "ruff (==0.5.5)", "types-docutils"] standalone = ["Sphinx (>=5)"] test = ["html5lib", "pytest"] -[[package]] -name = "sphinxcontrib-jquery" -version = "4.1" -description = "Extension to include jQuery on newer Sphinx releases" -optional = false -python-versions = ">=2.7" -files = [ - {file = "sphinxcontrib-jquery-4.1.tar.gz", hash = "sha256:1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a"}, - {file = "sphinxcontrib_jquery-4.1-py2.py3-none-any.whl", hash = "sha256:f936030d7d0147dd026a4f2b5a57343d233f1fc7b363f68b3d4f1cb0993878ae"}, -] - -[package.dependencies] -Sphinx = ">=1.8" - [[package]] name = "sphinxcontrib-jsmath" version = "1.0.1" @@ -2208,4 +2241,4 @@ files = [ [metadata] lock-version = "2.0" python-versions = "^3.10" -content-hash = "354de6083d85a65ffa172c886218bf6607f3555fccc4c64d7b4b366ce8d94fc3" +content-hash = "52e1d720ee281498a7707514e1e27a479ad8a8582744385c3380cfb6d911ece7" diff --git a/pyproject.toml b/pyproject.toml index 9942527..70e0014 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -108,8 +108,8 @@ psycopg2-binary = "^2.9.9" # https://www.sphinx-doc.org/en/master/ sphinx = "<9" # Theme for documentation -# https://pypi.org/project/sphinx-rtd-theme/ -sphinx-rtd-theme = ">=2,<4" +# https://github.com/pradyunsg/furo +furo = "^2024.8.6" [tool.poetry.group.local.dependencies] # A Python library for parsing and creating TOML