Skip to content

Commit 3e98087

Browse files
committed
..
1 parent dc5ed5f commit 3e98087

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

doc/development.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ Release process
3030

3131
1. Update the version number in ``petab/version.py``.
3232

33-
2. Update the changelog in ``doc/CHANGELOG.md``. The update content can be generated automatically: draft a new dummy GitHub release with a dummy tag and the ``develop`` branch, then click "Generate release notes".
33+
2. Update the changelog in ``doc/CHANGELOG.md``.
34+
The update content can be generated automatically:
35+
draft a new dummy GitHub release with a dummy tag and the ``develop``
36+
branch, then click :guilabel:`Generate release notes`.
3437

3538
3. Create a pull request with the changes to the main branch.
3639

@@ -39,8 +42,11 @@ Release process
3942
(e.g., ``v1.0.0``), and the release title to ``libpetab-python $RELEASE_TAG``
4043
(e.g., ``libpetab-python v1.0.0``).
4144

42-
5. Check that the release is now available on PyPI. The upload to PyPI is performed automatically by a GitHub Actions workflow, which may take a few minutes to complete.
45+
5. Check that the release is now available on PyPI.
46+
The upload to PyPI is performed automatically by a GitHub Actions workflow,
47+
which may take a few minutes to complete.
4348

49+
6. Merge the main branch back into the `develop` branch.
4450

4551
Style guide
4652
-----------
@@ -69,8 +75,10 @@ We use `Sphinx <https://www.sphinx-doc.org/>`_ to generate the documentation.
6975
The documentation is written in `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_.
7076

7177
We use the `sphinx docstring-style <https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html>`__ for new code.
72-
The ``:param [ParamName]:`` and ``:return:`` statements are important when applicable.
73-
Manual type annotations (``:type [ParamName]:``) are redundant and should be avoided.
78+
The ``:param [ParamName]:`` and ``:return:`` statements are important when
79+
applicable.
80+
Manual type annotations (``:type [ParamName]:``) are redundant and should be
81+
avoided.
7482

7583
To build the documentation, run:
7684

0 commit comments

Comments
 (0)