Skip to content

Commit 1db3ab8

Browse files
authored
Update devdocs (#176)
* Odd developer documentation improvements. * Typo in dev docs. * Various additional change fragments. * Fix selective changelog build (for non-bash RTD shell?). * Tweak whats-new entry.
1 parent a3053d7 commit 1db3ab8

File tree

6 files changed

+27
-4
lines changed

6 files changed

+27
-4
lines changed

docs/Makefile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ allapi:
1818
rm -rf ./details/api
1919
sphinx-apidoc -Mfe -o ./details/api ../lib/ncdata
2020

21+
# N.B. when no changelog entries pending, *don't* add a release section.
22+
# - this gives a "clean" changelog when building a release version.
2123
towncrier:
22-
if [ -e changelog_fragments/*.rst ]; then towncrier build --yes; fi
23-
24+
if [ "$$(ls changelog_fragments | grep "\.rst")" != "" ]; then towncrier build --yes; fi
2425

2526
# Tweaked "make html", which restores the changelog state after docs build.
2627
html-keeplog: html
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix xarray 2025.09.1 problem.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document how to create a developer installation.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Test against given Python versions : currently 3.12 and 3.13.
2+
**Not** python 3.14, for now, due to emerging problems with dependencies (notably Iris).

docs/details/developer_notes.rst

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ with a ``towncrier`` command-line command:
1919
* "feat": user features
2020
* "doc": documentation changes
2121
* "bug": bug fixes
22-
* "def": general developer-relevant changes
22+
* "dev": general developer-relevant changes
2323
* "misc": miscellaneous
2424

2525
(For reference, these categories are configured in ``pyproject.toml``).
@@ -29,6 +29,19 @@ with a ``towncrier`` command-line command:
2929
* N.B. for this to work well, every change should be identified with a matching github issue.
3030
If there are multiple associated PRs, they should all be linked to the issue.
3131

32+
.. _developer_install:
33+
34+
Developer Installation
35+
----------------------
36+
For an editable installation, make a Python environment containing at least **numpy,
37+
netCDF4, dask and pip**. It is also highly recommended to get
38+
`towncrier <https://github.com/twisted/towncrier>`_ and
39+
`pre-commit <https://github.com/pre-commit/pre-commit>`_.
40+
(and enable pre-commit with ``$ pre-commit install``).
41+
42+
Then, cd to your checkout, and ``$ pip install -e .``.
43+
This should result in an editable development installation.
44+
3245

3346
Documentation build
3447
-------------------
@@ -83,7 +96,7 @@ Release actions
8396

8497
#. create a new env with test dependencies
8598

86-
* ``$ conda create -n ncdtmp python=3.11 iris xarray filelock requests pytest pip``
99+
* ``$ conda create -n ncdtmp python=3.13 iris xarray filelock requests pytest pip``
87100
* ( N.B. 'filelock' and 'requests' are *test dependencies* of iris )
88101

89102
#. install the new package with

docs/userdocs/getting_started/installation.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,8 @@ Check install
2929
<NcData: <'no-name'>
3030
>
3131
32+
33+
Developer Installation
34+
----------------------
35+
To work on changes to the ncdata code, you will need an "editable installation".
36+
See : :ref:`developer_install`.

0 commit comments

Comments
 (0)