From 033f4e8b2debca541404517c094e28dd7b8937f0 Mon Sep 17 00:00:00 2001 From: Bill Little Date: Wed, 31 Jul 2024 10:08:15 +0100 Subject: [PATCH] docs: populate changelog post 0.5.0 release (#1027) * docs: populate changelog post 0.5.0 release * update user typo --- changelog/1000.dependency.rst | 2 ++ changelog/1001.dependency.rst | 2 ++ changelog/1006.documentation.rst | 1 + changelog/1007.community.rst | 1 + changelog/1008.internal.rst | 4 ++++ changelog/1009.documentation.rst | 3 +++ changelog/1010.documentation.rst | 1 + changelog/1011.community.rst | 1 + changelog/1012.documentation.rst | 1 + changelog/1013.dependency.rst | 2 ++ changelog/1013.documentation.rst | 2 ++ changelog/1014.documentation.rst | 3 +++ changelog/1016.documentation.rst | 2 ++ changelog/1019.dependency.rst | 2 ++ changelog/1020.dependency.rst | 4 ++++ changelog/1022.documentation.rst | 1 + changelog/1023.documentation.rst | 3 +++ changelog/1026.documentation.rst | 2 ++ changelog/987.documentation.rst | 3 +++ changelog/988.community.rst | 1 + changelog/989.internal.rst | 1 + changelog/993.community.rst | 1 + changelog/994.documentation.rst | 1 + changelog/996.internal.rst | 1 + changelog/997.feature.rst | 3 +++ changelog/999.internal.rst | 1 + pyproject.toml | 2 +- 27 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 changelog/1000.dependency.rst create mode 100644 changelog/1001.dependency.rst create mode 100644 changelog/1006.documentation.rst create mode 100644 changelog/1007.community.rst create mode 100644 changelog/1008.internal.rst create mode 100644 changelog/1009.documentation.rst create mode 100644 changelog/1010.documentation.rst create mode 100644 changelog/1011.community.rst create mode 100644 changelog/1012.documentation.rst create mode 100644 changelog/1013.dependency.rst create mode 100644 changelog/1013.documentation.rst create mode 100644 changelog/1014.documentation.rst create mode 100644 changelog/1016.documentation.rst create mode 100644 changelog/1019.dependency.rst create mode 100644 changelog/1020.dependency.rst create mode 100644 changelog/1022.documentation.rst create mode 100644 changelog/1023.documentation.rst create mode 100644 changelog/1026.documentation.rst create mode 100644 changelog/987.documentation.rst create mode 100644 changelog/988.community.rst create mode 100644 changelog/989.internal.rst create mode 100644 changelog/993.community.rst create mode 100644 changelog/994.documentation.rst create mode 100644 changelog/996.internal.rst create mode 100644 changelog/997.feature.rst create mode 100644 changelog/999.internal.rst diff --git a/changelog/1000.dependency.rst b/changelog/1000.dependency.rst new file mode 100644 index 00000000..36c3d9ec --- /dev/null +++ b/changelog/1000.dependency.rst @@ -0,0 +1,2 @@ +Skip the ``tests.bridge.test_from_tiff`` tests if the `rasterio `__ +optional package dependency is not installed. (:user:`bjlittle`) diff --git a/changelog/1001.dependency.rst b/changelog/1001.dependency.rst new file mode 100644 index 00000000..8d55e8ae --- /dev/null +++ b/changelog/1001.dependency.rst @@ -0,0 +1,2 @@ +Skip individual ``geovista.examples`` image tests if their optional package +dependencies are not installed. (:user:`bjlittle`) diff --git a/changelog/1006.documentation.rst b/changelog/1006.documentation.rst new file mode 100644 index 00000000..c3b4a503 --- /dev/null +++ b/changelog/1006.documentation.rst @@ -0,0 +1 @@ +Added ``sphinx`` `Internationalization `__ support. (:user:`tkoyama010`) diff --git a/changelog/1007.community.rst b/changelog/1007.community.rst new file mode 100644 index 00000000..1a2e77ec --- /dev/null +++ b/changelog/1007.community.rst @@ -0,0 +1 @@ +Added :user:`wx4stg` as a contributor for ``ideas`` and ``promotion``. (:user:`tkoyama010`) diff --git a/changelog/1008.internal.rst b/changelog/1008.internal.rst new file mode 100644 index 00000000..0ba84759 --- /dev/null +++ b/changelog/1008.internal.rst @@ -0,0 +1,4 @@ +Enabled the `nbQA `__ +``pre-commit`` hook to ensure tutorial ``jupyter`` notebook quality assurance +against `ruff `__ rule compliance. +(:user:`bjlittle`) diff --git a/changelog/1009.documentation.rst b/changelog/1009.documentation.rst new file mode 100644 index 00000000..7cb38627 --- /dev/null +++ b/changelog/1009.documentation.rst @@ -0,0 +1,3 @@ +Enabled rendering a version badge in the primary sidebar, and a ``latest`` to +``stable`` version banner announcement for documentation on ``readthedocs``. +(:user:`bjlittle`) diff --git a/changelog/1010.documentation.rst b/changelog/1010.documentation.rst new file mode 100644 index 00000000..d4e8c171 --- /dev/null +++ b/changelog/1010.documentation.rst @@ -0,0 +1 @@ +Updated the version announcement banner for ``readthedocs``. (:user:`bjlittle`) diff --git a/changelog/1011.community.rst b/changelog/1011.community.rst new file mode 100644 index 00000000..376a32a8 --- /dev/null +++ b/changelog/1011.community.rst @@ -0,0 +1 @@ +Added :user:`tkoyama010` as a contributor for ``promotion``. (:user:`tkoyama010`) diff --git a/changelog/1012.documentation.rst b/changelog/1012.documentation.rst new file mode 100644 index 00000000..d4e8c171 --- /dev/null +++ b/changelog/1012.documentation.rst @@ -0,0 +1 @@ +Updated the version announcement banner for ``readthedocs``. (:user:`bjlittle`) diff --git a/changelog/1013.dependency.rst b/changelog/1013.dependency.rst new file mode 100644 index 00000000..3ad11b60 --- /dev/null +++ b/changelog/1013.dependency.rst @@ -0,0 +1,2 @@ +Introduced minimum pin ``sphinx-tags >=0.4`` for multi-line tags support. +(:user:`bjlittle`) diff --git a/changelog/1013.documentation.rst b/changelog/1013.documentation.rst new file mode 100644 index 00000000..f48ba7cd --- /dev/null +++ b/changelog/1013.documentation.rst @@ -0,0 +1,2 @@ +Refactored structure of ``geovista.examples`` `sphinx-tags `__. +Closes :issue:`823`. (:user:`bjlittle`) diff --git a/changelog/1014.documentation.rst b/changelog/1014.documentation.rst new file mode 100644 index 00000000..bbceb069 --- /dev/null +++ b/changelog/1014.documentation.rst @@ -0,0 +1,3 @@ +Moved the ``tags`` link from the primiary sidebar to a +`sphinx-design `__ card in +the :ref:`gv-reference` section. (:user:`bjlittle`) diff --git a/changelog/1016.documentation.rst b/changelog/1016.documentation.rst new file mode 100644 index 00000000..661eb3d9 --- /dev/null +++ b/changelog/1016.documentation.rst @@ -0,0 +1,2 @@ +Added ``changelog`` and ``whatsnew`` `sphinx-design `__ +cards to the :ref:`gv-reference` section. (:user:`bjlittle`) diff --git a/changelog/1019.dependency.rst b/changelog/1019.dependency.rst new file mode 100644 index 00000000..429dc8e9 --- /dev/null +++ b/changelog/1019.dependency.rst @@ -0,0 +1,2 @@ +Introduced minimum pin ``sphinx-autoapi >=3.0.0`` and purge use of obsolete +``autoapi_type`` configuration option. (:user:`bjlittle`) diff --git a/changelog/1020.dependency.rst b/changelog/1020.dependency.rst new file mode 100644 index 00000000..1f5e48ec --- /dev/null +++ b/changelog/1020.dependency.rst @@ -0,0 +1,4 @@ +Added the `sphinx-changelog `__ +package dependency for rendering a ``changelog`` from news fragments using +`towncrier `__ and generating a release +``changelong``. (:user:`bjlittle`) diff --git a/changelog/1022.documentation.rst b/changelog/1022.documentation.rst new file mode 100644 index 00000000..2e07d31f --- /dev/null +++ b/changelog/1022.documentation.rst @@ -0,0 +1 @@ +Fixed unset ``author`` in page footer of documentation. (:user:`bjlittle`) diff --git a/changelog/1023.documentation.rst b/changelog/1023.documentation.rst new file mode 100644 index 00000000..abe2905f --- /dev/null +++ b/changelog/1023.documentation.rst @@ -0,0 +1,3 @@ +Renamed the runtime generated examples gallery carousel from +``gallery-carousel.rst`` to ``gallery_carousel.rst`` in order to comply with +implicit documentation file naming convention. (:user:`bjlittle`) diff --git a/changelog/1026.documentation.rst b/changelog/1026.documentation.rst new file mode 100644 index 00000000..11de8995 --- /dev/null +++ b/changelog/1026.documentation.rst @@ -0,0 +1,2 @@ +Retro generated ``changelog`` entries for all relevant pull-request post 0.5.0 +release. (:user:`bjlittle`) diff --git a/changelog/987.documentation.rst b/changelog/987.documentation.rst new file mode 100644 index 00000000..251e0441 --- /dev/null +++ b/changelog/987.documentation.rst @@ -0,0 +1,3 @@ +Updated the :doc:`Region Manifold Extraction ` +tutorial to correct typos and add a cross-reference to +:meth:`pyvista.DataSetFilters.select_enclosed_points`. (:user:`bjlittle`) diff --git a/changelog/988.community.rst b/changelog/988.community.rst new file mode 100644 index 00000000..4ba95e04 --- /dev/null +++ b/changelog/988.community.rst @@ -0,0 +1 @@ +Added :user:`bjlittle` as a contributor for ``tutorial``. (:user:`tkoyama010`) diff --git a/changelog/989.internal.rst b/changelog/989.internal.rst new file mode 100644 index 00000000..0fe5e1bb --- /dev/null +++ b/changelog/989.internal.rst @@ -0,0 +1 @@ +Added `adRise/update-pr-branch `__ GHA to automatically update stale ``auto-merge`` pull-requests. (:user:`tkoyama010`) diff --git a/changelog/993.community.rst b/changelog/993.community.rst new file mode 100644 index 00000000..e9585aab --- /dev/null +++ b/changelog/993.community.rst @@ -0,0 +1 @@ +Added :user:`Hedonical` as a contributor for ``ideas``. (:user:`tkoyama010`) diff --git a/changelog/994.documentation.rst b/changelog/994.documentation.rst new file mode 100644 index 00000000..0e549b18 --- /dev/null +++ b/changelog/994.documentation.rst @@ -0,0 +1 @@ +Adopted the standard of naming the ``plotter`` as ``p`` throughout documentation, docs-strings and examples. (:user:`bjlittle`) diff --git a/changelog/996.internal.rst b/changelog/996.internal.rst new file mode 100644 index 00000000..628f3278 --- /dev/null +++ b/changelog/996.internal.rst @@ -0,0 +1 @@ +Enabled ``require_passed_checks`` for `adRise/update-pr-branch `__ GHA. (:user:`bjlittle`) diff --git a/changelog/997.feature.rst b/changelog/997.feature.rst new file mode 100644 index 00000000..7c8437e4 --- /dev/null +++ b/changelog/997.feature.rst @@ -0,0 +1,3 @@ +Added `NASA Black Marble `__ +"night lights" global texture :func:`geovista.pantry.textures.black_marble`. +Closes :issue:`992`. (:user:`bjlittle`) diff --git a/changelog/999.internal.rst b/changelog/999.internal.rst new file mode 100644 index 00000000..71767635 --- /dev/null +++ b/changelog/999.internal.rst @@ -0,0 +1 @@ +Merged back ``0.5.x`` release feature branch into ``main`` for ``0.5.1``. (:user:`bjlittle`) diff --git a/pyproject.toml b/pyproject.toml index 40f0b3fe..fef1a294 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -320,7 +320,7 @@ name = "✨ New Features" showcontent = true [[tool.towncrier.type]] -# New behaviours in existing features e.g., performance +# Updates to existing behaviours, including performance etc directory = "enhancement" name = "🚀 Enhancements" showcontent = true