Merge pull request #1334 from AllenInstitute/feature/1334-add-release…

…-notes Feature/1334 add release notes
AllenInstitute · Apr 15, 2022 · cdeaef4 · cdeaef4
2 parents 134ff2b + 87a9c77
commit cdeaef4
Show file tree

Hide file tree

Showing 5 changed files with 409 additions and 1 deletion.
diff --git a/Packages/doc/analysis-function-writing.rst b/Packages/doc/analysis-function-writing.rst
@@ -1,3 +1,5 @@
+.. _File analysis-function-writing.rst:
+
 Thirty six hints for writing analysis functions
 ===============================================
 

diff --git a/Packages/doc/developers.rst b/Packages/doc/developers.rst
@@ -78,11 +78,13 @@ data acquisition is blocked.
 Cutting a new release
 ~~~~~~~~~~~~~~~~~~~~~
 
--  Checkout the main branch
+-  Checkout a new branch ``git checkout -b feature/XXXX-release-notes main``
 -  Paste the contents of ``Packages\doc\releasenotes_template.rst`` to
    the top of ``Packages\doc\releasenotes.rst``
 -  Call ``tools\create-changelog.sh`` which generate a raw changelog and
    fill ``releasenotes.rst`` with a cleaned up version of it.
+-  Propose a pull request and get it merged
+-  Checkout the main branch
 -  Tag the current state with ``git tag Release_X.Y_*``, see ``git tag``
    for how the asterisk should look like
 -  Push the tag: ``git push origin $tag``. You can pass ``--dry-run`` for

diff --git a/Packages/doc/labnotebook-descriptions.rst b/Packages/doc/labnotebook-descriptions.rst
@@ -1,6 +1,8 @@
 Labnotebook descriptions
 ========================
 
+.. _Table Numerical Labnotebook Description:
+
 .. csv-table:: Numerical entries
    :file: /csv/labnotebook_numerical_description.csv
    :delim: tab