Skip to content

Commit

Permalink
fix(docs): add dynamic versioning to docs build
Browse files Browse the repository at this point in the history
fix(docs): add dunamai dep to docs build pipeline
  • Loading branch information
kenibrewer committed Oct 30, 2023
1 parent f482787 commit 7c2c79d
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ build:
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
- poetry install --with docs
- poetry install --with dev,docs --all-extras

sphinx:
builder: html
Expand Down
6 changes: 4 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import os
import sys
import pathlib
import dunamai
from datetime import date

sys.path.insert(0, os.path.abspath(".."))
Expand All @@ -27,8 +28,9 @@
date=date.today().year, author=author
)

# The full version, including alpha/beta/rc tags
version = pycytominer.__about__.__version__
# Get the version from dunamai (the backend of poetry-dynamic-versioning)
auto_version = dunamai.Version.from_git()
version = auto_version.serialize()
release = version

# -- General configuration ---------------------------------------------------
Expand Down
20 changes: 17 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ homepage = "https://pycytominer.readthedocs.io/"
repository = "https://github.com/cytomining/pycytominer"

[tool.poetry.dependencies]
python = ">=3.8"
python = ">=3.8,<4.0"
numpy = ">=1.16.5"
scipy = ">=1.5"
pandas = ">=1.2.0"
Expand Down Expand Up @@ -85,6 +85,7 @@ m2r2 = "^0.3.3.post2"
furo = "^2023.9.10"
mock = "^5.1.0"
autodoc = "^0.5.0"
dunamai = "^1.19.0"

[tool.poetry-dynamic-versioning]
enable = true
Expand Down

0 comments on commit 7c2c79d

Please sign in to comment.