From e40b6382934cdb00bcbe60d37c6bed6430bc995e Mon Sep 17 00:00:00 2001 From: Nicholas Hathaway Date: Thu, 4 Jun 2026 13:40:58 -0700 Subject: [PATCH] update to display version on manual; update workflow to release similar to pypi release; --- .github/workflows/docs.yml | 8 +++----- man/source/conf.py | 6 +++++- man/source/index.rst | 1 + 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a90f2a3..958b87e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,11 +2,9 @@ name: Deploy Sphinx docs to Pages on: push: - branches: [main] - paths: - - "src/pmotools/**" - - "man/**" - - ".github/workflows/docs.yml" + tags: + - 'v*.*.*' + - 'test*' workflow_dispatch: permissions: diff --git a/man/source/conf.py b/man/source/conf.py index f474485..e37984d 100644 --- a/man/source/conf.py +++ b/man/source/conf.py @@ -1,8 +1,10 @@ import os import sys +from pmotools import get_pmotools_version sys.path.insert(0, os.path.abspath("../../src")) + # Configuration file for the Sphinx documentation builder. # # For the full list of built-in configuration values, see the documentation: @@ -14,7 +16,9 @@ project = "pmotools-python" copyright = "2026, Nicholas Hathaway, Kathryn Murie" author = "Nicholas Hathaway, Kathryn Murie" -release = "v1.1.0" + +release = get_pmotools_version() # full version, e.g. "v1.1.0" +version = release # use the full string everywhere # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/man/source/index.rst b/man/source/index.rst index 714c9fa..c7d260e 100644 --- a/man/source/index.rst +++ b/man/source/index.rst @@ -5,6 +5,7 @@ Welcome to pmotools-python's documentation! =========================================== +**Version:** |version| .. toctree:: :maxdepth: 2