From 8b7b3c1dfe7b555546de7b5867339e799ef2c698 Mon Sep 17 00:00:00 2001 From: Chris Lunsford Date: Fri, 2 Aug 2024 22:15:48 -0400 Subject: [PATCH 1/6] Test initial docs workflow --- .github/workflows/docs.yml | 45 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..004b0b4 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,45 @@ +name: Docs + +on: + push: + branches: + - main + workflow_dispatch: + workflow_call: + +jobs: + build-and-publish: + name: Build and Publish Docs + runs-on: ubuntu-latest + permissions: + pages: write + id-token: write + environment: + name: github-pages + env: + POETRY_VIRTUALENVS_CREATE: false + steps: + - uses: actions/setup-python@v5 + with: + python-version: "3.12" + + - uses: Gr1N/setup-poetry@v9 + + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + fetch-tags: true + + - name: Install Dependencies + run: | + poetry self add "poetry-dynamic-versioning[plugin]" + poetry install --no-root --only=docs + + - name: Build Package + run: poetry build + + - name: Install Package + run: pip install dist/*.whl + + - name: Build & Publish Docs + uses: sphinx-notes/pages@v3 From 1f5ceccbf3b28fc17352ac2c3901e9fbd5a30efb Mon Sep 17 00:00:00 2001 From: Chris Lunsford Date: Fri, 2 Aug 2024 22:23:37 -0400 Subject: [PATCH 2/6] chore: Update docs workflow to disable checkout This commit updates the docs workflow by disabling the checkout step. This change is made to improve the efficiency of the workflow and reduce unnecessary operations during the build and publish process. --- .github/workflows/docs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 004b0b4..9b0c620 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -43,3 +43,5 @@ jobs: - name: Build & Publish Docs uses: sphinx-notes/pages@v3 + with: + checkout: false From e043953cfbfebe35b30997214734a1fe4f957551 Mon Sep 17 00:00:00 2001 From: Adam Weeks Date: Wed, 7 Aug 2024 16:19:28 -0400 Subject: [PATCH 3/6] chore(docs): use rtd theme --- .github/workflows/docs.yml | 1 + docs/conf.py | 9 +++------ docs/requirements.txt | 1 + 3 files changed, 5 insertions(+), 6 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9b0c620..f00286b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,6 +16,7 @@ jobs: id-token: write environment: name: github-pages + url: ${{ steps.deployment.outputs.page_url }} env: POETRY_VIRTUALENVS_CREATE: false steps: diff --git a/docs/conf.py b/docs/conf.py index c3b9a77..e2ced53 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,6 +6,7 @@ import webexpythonsdk +import sphinx_rtd_theme project = "webexpythonsdk" @@ -52,13 +53,9 @@ # a list of builtin themes. # # html_theme = 'alabaster' -on_rtd = os.environ.get("READTHEDOCS", None) == "True" -if not on_rtd: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..52b04f2 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinx_rtd_theme \ No newline at end of file From 86a9ee87a52afdbefdacad5d077660d4fffd2870 Mon Sep 17 00:00:00 2001 From: Adam Weeks Date: Wed, 7 Aug 2024 17:22:32 -0400 Subject: [PATCH 4/6] docs: update to gh-pages links #237 --- README.rst | 11 ++++------- pyproject.toml | 2 +- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 83136ee..0369f0f 100644 --- a/README.rst +++ b/README.rst @@ -10,8 +10,6 @@ webexpythonsdk :target: https://pypi.org/project/webexpythonsdk/ .. image:: https://img.shields.io/pypi/dw/webexpythonsdk.svg :target: https://pypi.org/project/webexpythonsdk/ -.. image:: https://readthedocs.org/projects/webexpythonsdk/badge/?version=latest - :target: http://webexpythonsdk.readthedocs.io/en/latest/?badge=latest --------------------------------------------------------------------------------------------------- @@ -111,7 +109,7 @@ Documentation ------------- **Excellent documentation is now available at:** -http://webexpythonsdk.readthedocs.io +https://webexcommunity.github.io/WebexPythonSDK Check out the Quickstart_ to dive in and begin using webexpythonsdk. @@ -180,14 +178,14 @@ this repository. .. _Community: https://eurl.io/#BJ0A8gfOQ .. _Contributing: https://github.com/WebexCommunity/WebexPythonSDK/blob/master/docs/contributing.rst .. _examples: https://github.com/WebexCommunity/WebexPythonSDK/tree/master/examples -.. _Introduction: http://webexpythonsdk.readthedocs.io/en/latest/user/intro.html +.. _Introduction: https://webexcommunity.github.io/WebexPythonSDK/user/intro.html .. _issues: https://github.com/WebexCommunity/WebexPythonSDK/issues -.. _migrate: https://webexpythonsdk.readthedocs.io/en/latest/user/migrate.html +.. _migrate: https://webexcommunity.github.io/WebexPythonSDK/user/migrate.html .. _pagination: https://developer.webex.com/docs/basics#pagination .. _projects: https://github.com/WebexCommunity/WebexPythonSDK/projects .. _pull request: https://github.com/WebexCommunity/WebexPythonSDK/pulls .. _pull requests: https://github.com/WebexCommunity/WebexPythonSDK/pulls -.. _Quickstart: http://webexpythonsdk.readthedocs.io/en/latest/user/quickstart.html +.. _Quickstart: https://webexcommunity.github.io/WebexPythonSDK/user/quickstart.html .. _Release Plan: https://github.com/WebexCommunity/WebexPythonSDK/wiki/Release-Plans .. _release/v0/ciscosparkapi: https://github.com/WebexCommunity/WebexPythonSDK/tree/release/v0/ciscosparkapi .. _release/v1/webexteamssdk: https://github.com/WebexCommunity/WebexPythonSDK/tree/release/v1/webexteamssdk @@ -195,5 +193,4 @@ this repository. .. _the repository: https://github.com/WebexCommunity/WebexPythonSDK .. _webexpythonsdk: https://github.com/WebexCommunity/WebexPythonSDK .. _webexpythonsdk: https://github.com/WebexCommunity/WebexPythonSDK -.. _webexpythonsdk.readthedocs.io: https://webexpythonsdk.readthedocs.io .. _webexteamssdk: https://github.com/WebexCommunity/WebexPythonSDK/tree/release/v1/webexteamssdk diff --git a/pyproject.toml b/pyproject.toml index c097332..1d4e70a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,7 +11,7 @@ license = "MIT" readme = "README.rst" homepage = "https://github.com/WebexCommunity/WebexPythonSDK" repository = "https://github.com/WebexCommunity/WebexPythonSDK" -documentation = "https://webexpythonsdk.readthedocs.io" +documentation = "https://webexcommunity.github.io/WebexPythonSDK" include = ["LICENSE", "README.rst"] keywords = ["cisco", "webex", "api", "sdk", "python"] classifiers = [ From 94cb10f294c30bf4e24d591deb4f1916149bb3dc Mon Sep 17 00:00:00 2001 From: Chris Lunsford Date: Wed, 7 Aug 2024 23:06:18 -0400 Subject: [PATCH 5/6] Update shields --- README.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 0369f0f..adf86dc 100644 --- a/README.rst +++ b/README.rst @@ -6,10 +6,22 @@ webexpythonsdk .. image:: https://img.shields.io/badge/license-MIT-blue.svg :target: https://github.com/WebexCommunity/WebexPythonSDK/blob/master/LICENSE -.. image:: https://img.shields.io/pypi/v/webexpythonsdk.svg - :target: https://pypi.org/project/webexpythonsdk/ -.. image:: https://img.shields.io/pypi/dw/webexpythonsdk.svg + :alt: License MIT +.. image:: https://img.shields.io/pypi/v/webexpythonsdk :target: https://pypi.org/project/webexpythonsdk/ + :alt: PyPI Version +.. image:: https://img.shields.io/pypi/dw/webexpythonsdk?label=webexpythonsdk + :target: https://pypistats.org/packages/webexpythonsdk + :alt: webexpythonsdk PyPI Downloads +.. image:: https://img.shields.io/pypi/dw/webexteamssdk?label=webexteamssdk + :target: https://pypistats.org/packages/webexteamssdk + :alt: webexteamssdk PyPI Downloads +.. image:: https://img.shields.io/github/actions/workflow/status/WebexCommunity/WebexPythonSDK/.github%2Fworkflows%2Fbuild-and-test.yml?label=tests + :alt: Tests Status +.. image:: https://img.shields.io/github/actions/workflow/status/WebexCommunity/WebexPythonSDK/.github%2Fworkflows%2Fdocs.yml?label=docs + :target: https://webexcommunity.github.io/WebexPythonSDK/ + :alt: Documentation Status + --------------------------------------------------------------------------------------------------- @@ -192,5 +204,4 @@ this repository. .. _releases: https://github.com/WebexCommunity/WebexPythonSDK/releases .. _the repository: https://github.com/WebexCommunity/WebexPythonSDK .. _webexpythonsdk: https://github.com/WebexCommunity/WebexPythonSDK -.. _webexpythonsdk: https://github.com/WebexCommunity/WebexPythonSDK .. _webexteamssdk: https://github.com/WebexCommunity/WebexPythonSDK/tree/release/v1/webexteamssdk From e417de1782d4d2c1eb64edcc7781a050f96275b4 Mon Sep 17 00:00:00 2001 From: Chris Lunsford Date: Wed, 7 Aug 2024 23:15:13 -0400 Subject: [PATCH 6/6] Update README.rst Fix shield formating / linebreak issue. --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index adf86dc..213ce4b 100644 --- a/README.rst +++ b/README.rst @@ -17,6 +17,7 @@ webexpythonsdk :target: https://pypistats.org/packages/webexteamssdk :alt: webexteamssdk PyPI Downloads .. image:: https://img.shields.io/github/actions/workflow/status/WebexCommunity/WebexPythonSDK/.github%2Fworkflows%2Fbuild-and-test.yml?label=tests + :target: https://github.com/WebexCommunity/WebexPythonSDK/actions/workflows/build-and-test.yml :alt: Tests Status .. image:: https://img.shields.io/github/actions/workflow/status/WebexCommunity/WebexPythonSDK/.github%2Fworkflows%2Fdocs.yml?label=docs :target: https://webexcommunity.github.io/WebexPythonSDK/