diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 38af8a5f..baa5a6c3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,6 +3,8 @@ on: push: branches: [ main ] paths: [ "docs/**", "mkdocs.yml", ".github/workflows/docs.yml" ] + pull_request: + paths: [ "docs/**", "mkdocs.yml", ".github/workflows/docs.yml" ] permissions: contents: write @@ -18,5 +20,7 @@ jobs: with: python-version: "3.12" cache: pip - - run: pip install mkdocs-material # add your other plugins - - run: mkdocs gh-deploy --force + - run: pip install ".[docs]" + - run: mkdocs build --strict + - if: github.event_name == 'push' + run: mkdocs gh-deploy --force diff --git a/README.md b/README.md index 81ef2c2e..3a5d00b8 100644 --- a/README.md +++ b/README.md @@ -394,6 +394,8 @@ The tool migrates resources in the correct dependency order: ## Documentation +Published docs: [https://redhat-cop.github.io/aap-bridge/](https://redhat-cop.github.io/aap-bridge/) + Full documentation is available via MkDocs with the Material theme. ### Viewing Documentation Locally diff --git a/mkdocs.yml b/mkdocs.yml index ed7a6a55..2cd5fa24 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,7 @@ site_name: AAP Bridge site_description: Production-grade migration tool for Ansible Automation Platform site_author: Antony Sallas +site_url: https://redhat-cop.github.io/aap-bridge/ repo_url: https://github.com/redhat-cop/aap-bridge repo_name: redhat-cop/aap-bridge diff --git a/pyproject.toml b/pyproject.toml index 286a86c5..60d99848 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -83,7 +83,7 @@ aap-bridge = "aap_migration.cli.main:main" [project.urls] Homepage = "https://github.com/redhat-cop/aap-bridge" -Documentation = "https://github.com/redhat-cop/aap-bridge/tree/main/docs" +Documentation = "https://redhat-cop.github.io/aap-bridge/" Repository = "https://github.com/redhat-cop/aap-bridge" "Bug Tracker" = "https://github.com/redhat-cop/aap-bridge/issues"