You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/development.rst
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,10 @@ Release process
30
30
31
31
1. Update the version number in ``petab/version.py``.
32
32
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`.
34
37
35
38
3. Create a pull request with the changes to the main branch.
36
39
@@ -39,8 +42,11 @@ Release process
39
42
(e.g., ``v1.0.0``), and the release title to ``libpetab-python $RELEASE_TAG``
40
43
(e.g., ``libpetab-python v1.0.0``).
41
44
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.
43
48
49
+
6. Merge the main branch back into the `develop` branch.
44
50
45
51
Style guide
46
52
-----------
@@ -69,8 +75,10 @@ We use `Sphinx <https://www.sphinx-doc.org/>`_ to generate the documentation.
69
75
The documentation is written in `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_.
70
76
71
77
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
0 commit comments