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

automate docs discovery of iris and python versions #3981

Merged
merged 5 commits into from
Feb 8, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
17 changes: 6 additions & 11 deletions docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,17 +95,12 @@ def autolog(message):

# Create a variable that can be inserted in the rst "|copyright_years|".
# You can add more variables here if needed.
rst_epilog = """
.. |copyright_years| replace:: {year_range}
.. |python_version| replace:: {python_version}
.. |iris_version| replace:: {iris_version}
.. |build_date| replace:: {build_date}
""".format(
year_range=f"2010 - {upper_copy_year}",
python_version=".".join([str(i) for i in sys.version_info[:3]]),
iris_version=f"v{version}",
build_date=f"({datetime.datetime.now().strftime('%d %b %Y')})",
)
rst_epilog = f"""
.. |copyright_years| replace:: {2010 - upper_copy_year}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should probably be: 2010 - {upper_copy_year}?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oopsie... good spot 👀

.. |python_version| replace:: {'.'.join([str(i) for i in sys.version_info[:3]])}
.. |iris_version| replace:: v{version}
.. |build_date| replace:: ({datetime.datetime.now().strftime('%d %b %Y')})
"""

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down
6 changes: 3 additions & 3 deletions docs/src/developers_guide/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,8 @@ These steps assume a release for ``v1.9`` is to be created.
Release Steps
~~~~~~~~~~~~~

#. Create the branch ``1.9.x`` on the main repo, not in a forked repo, for the
release candidate or release. The only exception is for a point/bugfix
release as it should already exist
#. Create the release feature branch ``1.9.x`` on `SciTools/iris`_.
The only exception is for a point/bugfix release, as it should already exist
#. Update the ``iris.__init__.py`` version string e.g., to ``1.9.0``
#. Update the what's new for the release:

Expand Down Expand Up @@ -175,4 +174,5 @@ Post Release Steps


.. _Read The Docs: https://readthedocs.org/projects/scitools-iris/builds/
.. _SciTools/iris: https://github.com/SciTools/iris
.. _tag on the SciTools/Iris: https://github.com/SciTools/iris/releases