Skip to content

Updated version numbers and documentation #21

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

Merged
ginic merged 1 commit into from
Jun 9, 2025
Merged

Updated version numbers and documentation #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
You should also add project tags for each release in Github, see [Managing releases in a repository](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).

## [Unreleased]


## [2.1.0] - 2025-06-09
### Changed
- GitHub workflow for linting and formatting uses ruff as a separate job

Expand Down
6 changes: 3 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@

# -- Project information -----------------------------------------------------

project = "testdoc"
copyright = "2023, Luke Ruud"
project = "cdstemplate"
copyright = "2023, UMass Amherst Center for Data Science"
author = "Luke Ruud"

# The full version, including alpha/beta/rc tags
release = "0.1"
release = "2.1.0"


# -- General configuration ---------------------------------------------------
Expand Down
7 changes: 6 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to testdoc's documentation!
Welcome to cdstemplate's documentation!
===================================
This is a sample python project template that has opinionated guidelines on
how to set up a python module for data science projects with unit tests and Sphinx documentation.

Autogenerated documentation for modules
=======================================
These are created from the python docstrings.

.. automodule:: cdstemplate.word_count
:members:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "cdstemplate"
version = "2.0.0"
version = "2.1.0"
description = "A template repo for data science and machine learning projects at UMass Center for Data Science."
readme = "README.md"

Expand Down