Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: remove support for doc deploy index #582

Merged
merged 15 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 0 additions & 45 deletions .github/workflows/ci_cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -149,20 +149,6 @@ jobs:
bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}

doc-index-dev:
name: "Deploy dev index docs"
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
needs: doc-deploy-dev
steps:
- name: "Deploy the latest documentation index"
uses: ansys/actions/doc-deploy-index@main
with:
cname: ${{ env.DOCUMENTATION_CNAME }}/version/dev
index-name: "actions-vdev"
host-url: ${{ vars.MEILISEARCH_HOST_URL }}
api-key: ${{ env.MEILISEARCH_API_KEY }}

release:
name: "Release to GitHub"
runs-on: ubuntu-latest
Expand Down Expand Up @@ -218,34 +204,3 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}

doc-index-stable:
name: "Deploy stable docs index"
if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
runs-on: ubuntu-latest
needs: doc-deploy-stable
steps:
- name: "Install Git and clone project"
uses: actions/checkout@v4

- name: "get version of library"
shell: bash
run: |
echo "FULL_VERSION=$(cat VERSION)" >> $GITHUB_ENV

- name: Scrape the stable documentation to PyMeilisearch
run: |
VERSION=$(python -c "import os; version=os.environ['FULL_VERSION']; print('.'.join(version.split('.')[:2]))")
VERSION_MEILI=$(python -c "import os; version=os.environ['FULL_VERSION']; print('-'.join(version.split('.')[:2]))")
echo "Calculated VERSION: $VERSION"
echo "Calculated VERSION_MEILI: $VERSION_MEILI"
echo "VERSION=$VERSION" >> $GITHUB_ENV
echo "VERSION_MEILI=$VERSION_MEILI" >> $GITHUB_ENV

- name: "Deploy the latest documentation index"
uses: ansys/actions/doc-deploy-index@main
with:
cname: ${{ env.DOCUMENTATION_CNAME }}/version/${{ env.VERSION }}
index-name: actions-v${{ env.VERSION_MEILI }}
host-url: ${{ vars.MEILISEARCH_HOST_URL }}
api-key: ${{ env.MEILISEARCH_API_KEY }}
183 changes: 0 additions & 183 deletions doc-deploy-index/action.yml

This file was deleted.

4 changes: 2 additions & 2 deletions doc/source/cheat_sheet.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ footerlinks:
execute:
# output: false
eval: false

latex-clean: true
latex-auto-install: true
jupyter:
jupytext:
text_representation:
Expand All @@ -24,6 +23,7 @@ jupyter:
display_name: Python 3 (ipykernel)
language: python
name: python3

---
{%- for action_name, action_data in actions.items() %}
# {{ action_name | capitalize }}
Expand Down
6 changes: 0 additions & 6 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,6 @@
"json_url": f"https://{cname}/versions.json",
"version_match": switcher_version,
},
"use_meilisearch": {
"api_key": os.getenv("MEILISEARCH_PUBLIC_API_KEY", ""),
"index_uids": {
f"actions-v{switcher_version.replace('.', '-')}": "Ansys-actions",
},
},
"cheatsheet": {
"file": "cheat_sheet.qmd",
"title": "Actions cheat sheet",
Expand Down
14 changes: 0 additions & 14 deletions doc/source/doc-actions/examples/doc-deploy-index.yml

This file was deleted.

6 changes: 0 additions & 6 deletions doc/source/doc-actions/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,6 @@ Doc deploy stable action
.. jinja:: doc-deploy-stable
:file: _templates/action.rst.jinja

Doc deploy index action
------------------------

.. jinja:: doc-deploy-index
:file: _templates/action.rst.jinja

Doc changelog action
--------------------

Expand Down
1 change: 0 additions & 1 deletion requirements/requirements_doc.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
ansys-sphinx-theme==1.0.11
jupyter==1.1.1
nbformat==5.10.4
Revathyvenugopal162 marked this conversation as resolved.
Show resolved Hide resolved
pyyaml==6.0.2
Sphinx==8.0.2
sphinx-copybutton==0.5.2
Expand Down