Skip to content

Commit

Permalink
Remove non-API docs and tutorials (Cherry-pick of Qiskit#11352) (Qisk…
Browse files Browse the repository at this point in the history
…it#11398)

* Remove non-API docs and tutorials (Qiskit#11352)

* Remove non-API docs and tutorials

* Remove sphinx-design

* Fix bad reference

* Fix bad deploy step

* Remove translatable strings script

* Fix bad merge conflict in tox.ini

* Delete contributing guides
  • Loading branch information
Eric-Arellano committed Dec 14, 2023
1 parent 16ff633 commit 232bf01
Show file tree
Hide file tree
Showing 58 changed files with 147 additions and 59,112 deletions.
42 changes: 0 additions & 42 deletions .azure/tutorials-linux.yml

This file was deleted.

61 changes: 1 addition & 60 deletions .github/workflows/docs_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ on:
description: "Push to qiskit.org?"
required: false
type: boolean
do_translatables:
description: "Push translatable strings?"
required: false
type: boolean

jobs:
build:
Expand Down Expand Up @@ -53,33 +49,8 @@ jobs:
- name: Install dependencies
run: tools/install_ubuntu_docs_dependencies.sh

# This is just to have tox create the environment, so we can use it to execute the tutorials.
# We want to re-use it later for the build, hence 'tox run --notest' instead of 'tox devenv'.
- name: Prepare Python environment
run: tox run -e docs --notest

# The reason to use the custom script rather than letting 'nbsphinx' do its thing normally
# within the Sphinx build is so that the execution process is the same as in the test CI.
- name: Execute tutorials in place
run: .tox/docs/bin/python tools/execute_tutorials.py docs/tutorials
env:
QISKIT_CELL_TIMEOUT: "300"

- name: Build documentation
# We can skip re-installing the package, since we just did it a couple of steps ago.
run: tox run -e docs --skip-pkg-install
env:
QISKIT_ENABLE_ANALYTICS: "true"
# We've already built them.
QISKIT_DOCS_BUILD_TUTORIALS: "never"
DOCS_PROD_BUILD: "true"

- name: Build translatable strings
run: tox run -e gettext
env:
# We've already built them.
QISKIT_DOCS_BUILD_TUTORIALS: "never"
DOCS_PROD_BUILD: "true"
run: tox run -e docs

- name: Store built documentation artifact
uses: actions/upload-artifact@v3
Expand All @@ -91,13 +62,6 @@ jobs:
!**/.buildinfo
if-no-files-found: error

- name: Store translatable strings artifact
uses: actions/upload-artifact@v3
with:
name: qiskit-translatables
path: ./docs/locale/en/*
if-no-files-found: error

deploy:
if: github.event_name != 'workflow_dispatch' || inputs.do_deployment
name: Deploy to qiskit.org
Expand Down Expand Up @@ -198,26 +162,3 @@ jobs:
JOINED_PREFIXES: ${{ steps.choose.outputs.joined_prefixes }}
RCLONE_KEY: ${{ secrets.ENCRYPTED_RCLONE_KEY}}
RCLONE_IV: ${{ secrets.ENCRYPTED_RCLONE_IV }}

deploy_translatables:
if: (github.event_name == 'workflow_dispatch' && inputs.do_translatables) || (github.event_name == 'push' && github.ref_type == 'tag' && github.ref_name == needs.build.outputs.latest_tag)
name: Push translatable strings
needs: [build]
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
with:
path: 'qiskit'

- uses: actions/download-artifact@v3
with:
name: qiskit-translatables
path: 'deploy'

- name: Deploy translations
id: ssh_key
run: qiskit/tools/deploy_translatable_strings.sh "${{ github.workspace }}/deploy"
env:
encrypted_deploy_po_branch_key: ${{ secrets.ENCRYPTED_DEPLOY_PO_BRANCH_KEY }}
encrypted_deploy_po_branch_iv: ${{ secrets.ENCRYPTED_DEPLOY_PO_BRANCH_IV }}
14 changes: 2 additions & 12 deletions azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,6 @@ parameters:
type: string
default: "3.9"

- name: "tutorialsPythonVersion"
displayName: "Version of Python to use to run the tutorials job"
type: string
default: "3.8"

# Sync with 'python-version' in '.github/workflows/docs_deploy.yml'.
- name: "documentationPythonVersion"
displayName: "Version of Python to use to build Sphinx documentation"
Expand Down Expand Up @@ -162,18 +157,13 @@ stages:
testImages: true

# The rest of the PR pipeline is to test the oldest and newest supported
# versions of Python, along with the integration tests (via the tutorials).
# It's very rare for a failure to be specific to an intermediate version of
# versions of Python. It's very rare for a failure to be specific to an intermediate version of
# Python, so we just catch those in the cron-job pipeline to reduce the
# amount of resources used.
- stage: "Tutorials_and_Tests"
- stage: "Tests"
displayName: "Main tests"
dependsOn: "Lint_Docs_Prelim_Tests"
jobs:
- template: ".azure/tutorials-linux.yml"
parameters:
pythonVersion: ${{ parameters.tutorialsPythonVersion }}

- template: ".azure/test-linux.yml"
parameters:
pythonVersion: ${{ parameters.maximumPythonVersion }}
Expand Down
Binary file removed docs/_static/images/1xp.png
Binary file not shown.
Binary file removed docs/_static/images/ibm_qlab.png
Binary file not shown.
Binary file removed docs/_static/images/strangeworks.png
Binary file not shown.
Loading

0 comments on commit 232bf01

Please sign in to comment.