Skip to content

Commit

Permalink
Merge remote-tracking branch 'upsteam/RELEASE_next_patch' into RELEAS…
Browse files Browse the repository at this point in the history
…E_next_minor
  • Loading branch information
ericpre committed Jan 14, 2024
2 parents 495563f + 17595ab commit 00a3e7a
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ jobs:
git remote add upstream https://github.com/hyperspy/hyperspy.git
git fetch upstream --tags
- uses: actions/setup-python@v4
- uses: actions/setup-python@v5
name: Install Python
with:
python-version: ${{ matrix.PYTHON_VERSION }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests_extension.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
steps:
- uses: actions/checkout@v4

- uses: conda-incubator/setup-miniconda@v2
- uses: conda-incubator/setup-miniconda@v3
with:
miniforge-variant: Mambaforge
miniforge-version: latest
Expand Down
9 changes: 3 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. -*- mode: rst -*-
|Azure|_ |Github|_ |Drone|_ |rtd|_ |Codecov|_
|Azure|_ |Github|_ |rtd|_ |Codecov|_

|python_version|_ |pypi_version|_ |anaconda_cloud|_

Expand All @@ -9,11 +9,8 @@
.. |Azure| image:: https://dev.azure.com/franciscode-la-pena-manchon/hyperspy/_apis/build/status/hyperspy.hyperspy?branchName=RELEASE_next_minor
.. _Azure: https://dev.azure.com/franciscode-la-pena-manchon/hyperspy/_build?definitionId=1&_a=summary&view=branches

.. |Github| image:: https://github.com/hyperspy/hyperspy/workflows/Tests/badge.svg
.. _Github: https://github.com/hyperspy/hyperspy/actions?query=workflow%3ATests

.. |Drone| image:: https://cloud.drone.io/api/badges/hyperspy/hyperspy/status.svg
.. _Drone: https://cloud.drone.io/hyperspy/hyperspy
.. |Github| image:: https://github.com/hyperspy/hyperspy/actions/workflows/tests.yml/badge.svg
.. _Github: https://github.com/hyperspy/hyperspy/actions/workflows/tests.yml

.. |Codecov| image:: https://codecov.io/gh/hyperspy/hyperspy/branch/RELEASE_next_minor/graph/badge.svg
.. _Codecov: https://codecov.io/gh/hyperspy/hyperspy
Expand Down
10 changes: 7 additions & 3 deletions doc/_static/switcher.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
[
{
"name": "v2.0 (dev)",
"version": "2.0",
"name": "dev",
"version": "dev",
"url": "https://hyperspy.org/hyperspy-doc/dev/"
},
{
"version": "1.7",
"version": "2.0",
"url": "https://hyperspy.org/hyperspy-doc/current/"
},
{
"version": "1.7",
"url": "https://hyperspy.org/hyperspy-doc/v1.7/"
},
{
"version": "1.6",
"url": "https://hyperspy.org/hyperspy-doc/v1.6/"
Expand Down
11 changes: 10 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,15 @@

favicons = ["hyperspy.ico", ]

# For version switcher:
# For development, we match to the dev version in `switcher.json`
# for release version, we match to the minor increment
import hyperspy
_version = hyperspy.__version__
version_match = "dev" if "dev" in _version else ".".join(_version.split(".")[:2])

print("version_match:", version_match)

html_theme_options = {
"show_toc_level": 2,
"github_url": "https://github.com/hyperspy/hyperspy",
Expand Down Expand Up @@ -190,7 +199,7 @@
"switcher": {
# Update when merged and released
"json_url": "https://hyperspy.org/hyperspy-doc/dev/_static/switcher.json",
"version_match": version,
"version_match": version_match,
},
"navbar_start": ["navbar-logo", "version-switcher"],
"announcement": "HyperSpy API is changing in version 2.0, see the <a href='https://hyperspy.org/hyperspy-doc/current/changes.html'>release notes!</a>",
Expand Down
6 changes: 0 additions & 6 deletions doc/user_guide/basic_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,6 @@ associated to a given functions (docstring in Python jargon) and it is one of
the many features of `IPython <https://ipython.readthedocs.io/>`_, which is the
interactive python shell that HyperSpy uses under the hood.

Please note that the documentation of the code is a work in progress, so not
all the objects are documented yet.

Up-to-date documentation is always available in `the HyperSpy website.
<https://hyperspy.org/documentation.html>`_


Autocompletion
--------------
Expand Down
2 changes: 1 addition & 1 deletion doc/user_guide/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ solutions are:

To learn more about the Anaconda eco-system:

- Choose between `Anaconda or Miniconda <https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html#anaconda-or-miniconda>`_?
- Choose between `Anaconda or Miniconda <https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html>`_?
- Understanding `conda and pip <https://www.anaconda.com/blog/understanding-conda-and-pip>`_.
- What is `conda-forge <https://conda-forge.org>`__.

Expand Down
1 change: 1 addition & 0 deletions upcoming_changes/3291.maintenance.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update version switcher.
1 change: 1 addition & 0 deletions upcoming_changes/3298.maintenance.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix readme badges and fix broken web links.

0 comments on commit 00a3e7a

Please sign in to comment.