From 28e6f2f9e27e35ba9442bb40d03ee563ecc36729 Mon Sep 17 00:00:00 2001 From: Dom Batten Date: Fri, 12 Jan 2024 18:28:49 +0000 Subject: [PATCH] Add docs build to github actions --- .github/workflows/tests.yml | 8 ++++++++ README.md | 2 +- pyproject.toml | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 264eb54..c3aa675 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -32,6 +32,7 @@ jobs: # - { python: "3.11", os: macos-latest, session: "tests" } - { python: "3.11", os: ubuntu-latest, session: "typeguard" } - { python: "3.11", os: ubuntu-latest, session: "xdoctest" } + - { python: "3.11", os: "ubuntu-latest", session: "docs-build" } env: NOXSESSION: ${{ matrix.session }} @@ -107,6 +108,13 @@ jobs: name: coverage-data path: ".coverage.*" + - name: Upload documentation + if: matrix.session == 'docs-build' + uses: actions/upload-artifact@v3 + with: + name: docs + path: docs/_build + coverage: runs-on: ubuntu-latest needs: tests diff --git a/README.md b/README.md index a1a0466..f6e769f 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ if config.get_option("enable_useful_option"): ## Help -See the [documentation](https://dbatten5.github.io/maison) for more details. +See the [documentation](https://maison.readthedocs.io) for more details. ## Licence diff --git a/pyproject.toml b/pyproject.toml index f4c2e00..ac622d5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ license = "MIT" readme = "README.md" homepage = "https://github.com/dbatten5/maison" repository = "https://github.com/dbatten5/maison" -documentation = "https://dbatten5.github.io/maison" +documentation = "https://maison.readthedocs.io" classifiers = [ "Development Status :: 3 - Alpha", "Programming Language :: Python :: 3.8",