Skip to content

Commit

Permalink
docs: populate changelog post 0.5.0 release (#1027)
Browse files Browse the repository at this point in the history
* docs: populate changelog post 0.5.0 release

* update user typo
  • Loading branch information
bjlittle authored Jul 31, 2024
1 parent fc8e186 commit 033f4e8
Show file tree
Hide file tree
Showing 27 changed files with 50 additions and 1 deletion.
2 changes: 2 additions & 0 deletions changelog/1000.dependency.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Skip the ``tests.bridge.test_from_tiff`` tests if the `rasterio <https://github.com/rasterio/rasterio>`__
optional package dependency is not installed. (:user:`bjlittle`)
2 changes: 2 additions & 0 deletions changelog/1001.dependency.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Skip individual ``geovista.examples`` image tests if their optional package
dependencies are not installed. (:user:`bjlittle`)
1 change: 1 addition & 0 deletions changelog/1006.documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added ``sphinx`` `Internationalization <https://www.sphinx-doc.org/en/master/usage/advanced/intl.html#quick-guide>`__ support. (:user:`tkoyama010`)
1 change: 1 addition & 0 deletions changelog/1007.community.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added :user:`wx4stg` as a contributor for ``ideas`` and ``promotion``. (:user:`tkoyama010`)
4 changes: 4 additions & 0 deletions changelog/1008.internal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Enabled the `nbQA <https://github.com/nbQA-dev/nbQA/tree/main>`__
``pre-commit`` hook to ensure tutorial ``jupyter`` notebook quality assurance
against `ruff <https://github.com/astral-sh/ruff>`__ rule compliance.
(:user:`bjlittle`)
3 changes: 3 additions & 0 deletions changelog/1009.documentation.rst
Original file line number Diff line number Diff line change
@@ -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`)
1 change: 1 addition & 0 deletions changelog/1010.documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updated the version announcement banner for ``readthedocs``. (:user:`bjlittle`)
1 change: 1 addition & 0 deletions changelog/1011.community.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added :user:`tkoyama010` as a contributor for ``promotion``. (:user:`tkoyama010`)
1 change: 1 addition & 0 deletions changelog/1012.documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updated the version announcement banner for ``readthedocs``. (:user:`bjlittle`)
2 changes: 2 additions & 0 deletions changelog/1013.dependency.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Introduced minimum pin ``sphinx-tags >=0.4`` for multi-line tags support.
(:user:`bjlittle`)
2 changes: 2 additions & 0 deletions changelog/1013.documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Refactored structure of ``geovista.examples`` `sphinx-tags <https://github.com/melissawm/sphinx-tags>`__.
Closes :issue:`823`. (:user:`bjlittle`)
3 changes: 3 additions & 0 deletions changelog/1014.documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Moved the ``tags`` link from the primiary sidebar to a
`sphinx-design <https://github.com/executablebooks/sphinx-design>`__ card in
the :ref:`gv-reference` section. (:user:`bjlittle`)
2 changes: 2 additions & 0 deletions changelog/1016.documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added ``changelog`` and ``whatsnew`` `sphinx-design <https://github.com/executablebooks/sphinx-design>`__
cards to the :ref:`gv-reference` section. (:user:`bjlittle`)
2 changes: 2 additions & 0 deletions changelog/1019.dependency.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Introduced minimum pin ``sphinx-autoapi >=3.0.0`` and purge use of obsolete
``autoapi_type`` configuration option. (:user:`bjlittle`)
4 changes: 4 additions & 0 deletions changelog/1020.dependency.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Added the `sphinx-changelog <https://github.com/OpenAstronomy/sphinx-changelog>`__
package dependency for rendering a ``changelog`` from news fragments using
`towncrier <https://github.com/twisted/towncrier>`__ and generating a release
``changelong``. (:user:`bjlittle`)
1 change: 1 addition & 0 deletions changelog/1022.documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed unset ``author`` in page footer of documentation. (:user:`bjlittle`)
3 changes: 3 additions & 0 deletions changelog/1023.documentation.rst
Original file line number Diff line number Diff line change
@@ -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`)
2 changes: 2 additions & 0 deletions changelog/1026.documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Retro generated ``changelog`` entries for all relevant pull-request post 0.5.0
release. (:user:`bjlittle`)
3 changes: 3 additions & 0 deletions changelog/987.documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Updated the :doc:`Region Manifold Extraction </tutorials/region-manifold-extraction>`
tutorial to correct typos and add a cross-reference to
:meth:`pyvista.DataSetFilters.select_enclosed_points`. (:user:`bjlittle`)
1 change: 1 addition & 0 deletions changelog/988.community.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added :user:`bjlittle` as a contributor for ``tutorial``. (:user:`tkoyama010`)
1 change: 1 addition & 0 deletions changelog/989.internal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added `adRise/update-pr-branch <https://github.com/adRise/update-pr-branch>`__ GHA to automatically update stale ``auto-merge`` pull-requests. (:user:`tkoyama010`)
1 change: 1 addition & 0 deletions changelog/993.community.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added :user:`Hedonical` as a contributor for ``ideas``. (:user:`tkoyama010`)
1 change: 1 addition & 0 deletions changelog/994.documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Adopted the standard of naming the ``plotter`` as ``p`` throughout documentation, docs-strings and examples. (:user:`bjlittle`)
1 change: 1 addition & 0 deletions changelog/996.internal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Enabled ``require_passed_checks`` for `adRise/update-pr-branch <https://github.com/adRise/update-pr-branch>`__ GHA. (:user:`bjlittle`)
3 changes: 3 additions & 0 deletions changelog/997.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Added `NASA Black Marble <https://earthobservatory.nasa.gov/images/90008/night-light-maps-open-up-new-applications>`__
"night lights" global texture :func:`geovista.pantry.textures.black_marble`.
Closes :issue:`992`. (:user:`bjlittle`)
1 change: 1 addition & 0 deletions changelog/999.internal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Merged back ``0.5.x`` release feature branch into ``main`` for ``0.5.1``. (:user:`bjlittle`)
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 033f4e8

Please sign in to comment.