Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CAS-66 Don't show pre-release rel notes #80

Merged
merged 3 commits into from
Aug 15, 2024
Merged

CAS-66 Don't show pre-release rel notes #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c1b6d8
Removed unused import
nmalfroy Aug 14, 2024
6c0f74d
Update setuptools_git_versioning library
nmalfroy Aug 14, 2024
39d80c6
Comment temp changelog so that it doesn't appear
nmalfroy Aug 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,20 @@ All notable changes to Cellarium CAS client will be documented in this file.
The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.

<pre-version> - <pre-date>
--------------------------

Changed
~~~~~~~
- Added ability to render documentation locally
- PR tests will now fail when doc is invalid
- Fixed bugs documentation navigation
..
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a syntax for comments?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep!

The text in this block is where pre-release changes should live.
On release, a commit should be created to copy the block just below with the new version number and date.
Then a new block should be created here for the next version.

<pre-version> - <pre-date>
--------------------------

Changed
~~~~~~~
- Added ability to render documentation locally
- PR tests will now fail when doc is invalid
- Fixed bugs documentation navigation

1.4.12 - 2024-08-01
-------------------
Expand Down
1 change: 0 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import time

from sphinx.application import Sphinx
from setuptools_git_versioning import get_tag

# -- Project information -----------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion requirements/docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Sphinx~=7.4
sphinx_gallery~=0.14
sphinx_rtd_theme~=2.0
sphinx_substitution_extensions==2024.8.6
setuptools-git-versioning==1.13.5
setuptools-git-versioning==2.0.0