Skip to content

Commit

Permalink
Merge pull request #3086 from jlaehne/doc-changes-labels
Browse files Browse the repository at this point in the history
Add missing labels to changelog sections ...
  • Loading branch information
ericpre committed Jan 22, 2023
2 parents 9ef66d6 + 0883183 commit da5a683
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 3 deletions.
15 changes: 15 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,9 @@ Preferences

.. towncrier release notes start
.. _changes_1.7.3:

v1.7.3 (2022-10-29)
===========================

Expand All @@ -216,6 +219,8 @@ Maintenance
- Fix getting random state dask for dask>=2022.10.0 (`#3049 <https://github.com/hyperspy/hyperspy/issues/3049>`_)


.. _changes_1.7.2:

v1.7.2 (2022-09-17)
===========================

Expand Down Expand Up @@ -246,6 +251,8 @@ Maintenance
- Fix matplotlib ``SpanSelector`` import for matplotlib 3.6 (`#3016 <https://github.com/hyperspy/hyperspy/issues/3016>`_)


.. _changes_1.7.1:

v1.7.1 (2022-06-18)
===================

Expand Down Expand Up @@ -278,6 +285,8 @@ Maintenance
- Fix packaging of test suite and tweak tests to pass on different platform of blas implementation (`#2933 <https://github.com/hyperspy/hyperspy/issues/2933>`_)


.. _changes_1.7.0:

v1.7.0 (2022-04-26)
===================

Expand Down Expand Up @@ -378,6 +387,8 @@ Maintenance
- Compress some tiff tests files to reduce package size (`#2926 <https://github.com/hyperspy/hyperspy/issues/2926>`_)


.. _changes_1.6.5:

v1.6.5 (2021-10-28)
===================

Expand All @@ -404,6 +415,8 @@ Enhancements
- :py:meth:`~.roi.BaseInteractiveROI.add_widget` can now take a string or integer instead of tuple of string or integer (`#2809 <https://github.com/hyperspy/hyperspy/issues/2809>`_)


.. _changes_1.6.4:

v1.6.4 (2021-07-08)
===================

Expand Down Expand Up @@ -434,6 +447,8 @@ Maintenance
- Fix image comparison failure with numpy 1.21.0 (`#2774 <https://github.com/hyperspy/hyperspy/issues/2774>`_)


.. _changes_1.6.3:

v1.6.3 (2021-06-10)
===================

Expand Down
17 changes: 17 additions & 0 deletions doc/reference/metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ in the following sections of this chapter.
├── signal_type
└── signal_origin


.. _general-metadata:

General
=======

Expand Down Expand Up @@ -208,6 +211,8 @@ timestamp
timezone-aware format). The timestamp will be in ISO 8601 format, as
produced by the ``isoformat()`` method of the ``datetime`` class.

.. _source-metadata:

Acquisition_instrument
======================

Expand Down Expand Up @@ -306,6 +311,9 @@ working_distance

The working distance in mm.


.. _stage-metadata:

Stage
-----
tilt_alpha
Expand Down Expand Up @@ -338,6 +346,8 @@ z

The position of the stage in mm along the z axis.

.. _detector-metadata:

Detector
--------

Expand Down Expand Up @@ -444,6 +454,9 @@ voltage

Voltage of electrostatic biprism in volts


.. _sample-metadata:

Sample
======

Expand Down Expand Up @@ -476,6 +489,8 @@ thickness
The thickness of the sample in m.


.. _signal-metadata:

Signal
======

Expand Down Expand Up @@ -579,6 +594,8 @@ Folding
Constains parameters that related to the folding/unfolding of signals.


.. _metadata_handling:

Functions to handle the metadata
================================

Expand Down
8 changes: 5 additions & 3 deletions doc/user_guide/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ To install a specific version of hyperspy (for example ``1.6.1``) using pip:
$ pip install hyperspy==1.6.1
.. _install-dev:
.. _install-rolling:

Rolling release Linux distributions
-----------------------------------
Expand All @@ -268,6 +268,8 @@ the stable release) is also available in the AUR as |python-hyperspy-git|_.
.. |python-hyperspy-git| replace:: ``python-hyperspy-git``
.. _python-hyperspy-git: https://aur.archlinux.org/packages/python-hyperspy-git

.. _install-dev:

Install development version
---------------------------

Expand Down Expand Up @@ -336,8 +338,6 @@ use the corresponding selector as explained in the :ref:`install-with-pip` secti
can be installed through the AUR by installing the `hyperspy-git package
<https://aur.archlinux.org/packages/hyperspy-git/>`_
.. _create-debian-binary:

Installation in a system Python distribution
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand All @@ -351,6 +351,8 @@ From the root folder of your hyperspy repository (folder containing the
$ pip install -e --user .[dev]
.. _create-debian-binary:

Creating Debian/Ubuntu binaries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit da5a683

Please sign in to comment.