Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misc release items #1837

Merged
merged 8 commits into from
Apr 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
tags:
- v[0-9]+.[0-9]+.[0-9]+
pull_request:
release:

jobs:
#
Expand Down Expand Up @@ -133,7 +134,7 @@ jobs:
run: echo "DOC_VERSION=v$(python -c 'import metpy; print(metpy.__version__.rsplit(".", maxsplit=2)[0])')" >> $GITHUB_ENV

- name: Upload to GitHub Pages
if: ${{ github.event_name != 'pull_request' && matrix.experimental == false }}
if: ${{ github.event_name != 'pull_request' && matrix.experimental == false && matrix.python-version == '3.9' }}
uses: peaceiris/actions-gh-pages@v3.8.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/draft-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ jobs:
tag_name: 'v' + milestone.title,
name: milestone.title,
draft: true,
body: body
body: body,
discussion_category_name: 'Announcements'
};
const match = milestone.description.match(/branch:\s*([^\s]+)/);
if (!!match) {
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ jobs:
env:
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
set -o pipefail
flake8 | reviewdog -f=pep8 -name=flake8 -reporter=github-check -filter-mode=nofilter

- name: Run doc8
Expand Down
5 changes: 4 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ on:
jobs:
packages:
name: Release Packages
environment:
name: PyPI
url: https://pypi.org/project/MetPy/
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 150
fetch-depth: 10

- name: Get tags
run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
Expand Down
7 changes: 5 additions & 2 deletions docs/devel/infrastructureguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,13 @@ extension also makes these scripts available as Jupyter notebooks.
The documentation is hosted on `GitHub Pages <https://unidata.github.io/MetPy>`_. The docs are
built automatically and uploaded upon pushes or merges to GitHub. Commits to ``main`` end up
in our development version docs, while commits to versioned branches will update the
docs for the corresponding version, which are located in the appropriately named subidrectory
docs for the corresponding version, which are located in the appropriately named subdirectory
on the ``gh-pages`` branch. We only maintain docs at the minor level, not the bugfix one.
The docs rely on the ``pydata-sphinx-theme`` package for styling the docs, which needs to be
installed for any local doc builds.
installed for any local doc builds. The ``gh-pages`` branch has a GitHub Actions workflow that
handles generating a ``versions.json`` file that controls what versions are displayed in the
selector on the website, as well as update the ``latest`` symlink that points to the latest
version of the docs.

-----------
Other Tools
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ per-file-ignores = examples/*.py: D MPY001 T003 T001

[flake8:local-plugins]
extension = MPY = flake8_metpy:MetPyChecker
paths = ./tools/flake8_metpy
paths = ./tools/flake8-metpy

[tool:pytest]
# https://github.com/matplotlib/pytest-mpl/issues/69
Expand Down
8 changes: 4 additions & 4 deletions src/metpy/calc/thermo.py
Original file line number Diff line number Diff line change
Expand Up @@ -1542,10 +1542,10 @@ def mixing_ratio_from_relative_humidity(pressure, temperature, relative_humidity
-----
Formula adapted from [Hobbs1977]_ pg. 74.

.. math:: w = (relative_humidity)(w_s)
.. math:: w = (rh)(w_s)

* :math:`w` is mixing ratio
* :math:`relative_humidity` is relative humidity as a unitless ratio
* :math:`rh` is relative humidity as a unitless ratio
* :math:`w_s` is the saturation mixing ratio

.. versionchanged:: 1.0
Expand Down Expand Up @@ -1589,9 +1589,9 @@ def relative_humidity_from_mixing_ratio(pressure, temperature, mixing_ratio):
-----
Formula based on that from [Hobbs1977]_ pg. 74.

.. math:: relative_humidity = \frac{w}{w_s}
.. math:: rh = \frac{w}{w_s}

* :math:`relative_humidity` is relative humidity as a unitless ratio
* :math:`rh` is relative humidity as a unitless ratio
* :math:`w` is mixing ratio
* :math:`w_s` is the saturation mixing ratio

Expand Down