Skip to content

Commit bb9759d

Browse files
committed
Update documentation build and changelog
1 parent 9d1cfe0 commit bb9759d

File tree

5 files changed

+34
-8
lines changed

5 files changed

+34
-8
lines changed

.readthedocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ version: 2
77

88
# Set the OS, Python version and other tools you might need
99
build:
10-
os: ubuntu-22.04
10+
os: ubuntu-24.04
1111
tools:
12-
python: "3.8"
12+
python: "3.12"
1313

1414
# Build documentation in the docs/ directory with Sphinx
1515
sphinx:

docs/available_parameters.rst

+1
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ SW_OPER_TIX_TMS_2F TIX_TMS
123123
============================== ================
124124

125125
The `TIRO project <https://earth.esa.int/eogateway/activities/tiro>`_ provides products for TEC and Ne derived from CHAMP, GRACE, and GRACE-FO:
126+
126127
============================== ================
127128
Collection full name Collection type
128129
============================== ================

docs/release_notes.rst

+25
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,31 @@ Release notes
44
Change log
55
----------
66

7+
Changes from 0.12.3 to 0.13.0
8+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9+
10+
- Added support for new products:
11+
12+
- Swarm `ULF wave project <https://earth.esa.int/eogateway/activities/swarm-ulf-ionosphere>`_:
13+
14+
- ``SW_OPER_ULFxMAG_2F``
15+
- ``SW_OPER_PC1xMAG_2F``
16+
17+
- `MIGRAS project <https://earth.esa.int/eogateway/activities/migras>`_ providing ionospheric gradients of TEC and electron density:
18+
19+
- ``SW_OPER_NIX_TMS_2F``
20+
- ``SW_OPER_TIX_TMS_2F``
21+
22+
- `TIRO project <https://earth.esa.int/eogateway/activities/tiro>`_ providing TEC and electron density derived from CHAMP, GRACE, and GRACE-FO:
23+
24+
- ``CH_OPER_TEC_TMS_2F``
25+
- ``GR_OPER_TECxTMS_2F``
26+
- ``GF_OPER_TECxTMS_2F``
27+
- ``GR_OPER_NE__KBR_2F``
28+
- ``GF_OPER_NE__KBR_2F``
29+
30+
- Added :py:meth:`viresclient.SwarmRequest.get_collection_info` to query collection details from server (e.g. time extent)
31+
732
Changes from 0.12.2 to 0.12.3
833
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
934

noxfile.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ def lint(session):
1010
session.run("pre-commit", "run", "--all-files", *session.posargs)
1111

1212

13-
@nox.session(python=["3.6", "3.7", "3.8", "3.9", "3.10"])
13+
@nox.session(python=["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"])
1414
def tests(session):
1515
session.install(".")
1616
session.install("pytest")
1717
session.run("pytest")
1818

1919

20-
@nox.session
20+
@nox.session(python="3.12")
2121
def docs(session: nox.Session) -> None:
2222
"""
2323
Build the docs. Pass "serve" to serve.

pyproject.toml

+4-4
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ dev = [
5757
"nox >=2022",
5858
]
5959
docs = [
60-
"Sphinx == 4.5.0",
61-
"sphinx-book-theme == 0.3.3",
62-
"sphinx_copybutton == 0.5.0",
63-
"sphinx-tabs == 3.4.0",
60+
"Sphinx == 8.2",
61+
"sphinx-book-theme == 1.1.4",
62+
"sphinx-copybutton == 0.5.2",
63+
"sphinx-tabs == 3.4.7",
6464
]
6565

6666
[project.scripts]

0 commit comments

Comments
 (0)