Skip to content

Commit c75af15

Browse files
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
1 parent f12db3b commit c75af15

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+148
-58588
lines changed

.azure/tutorials-linux.yml

-42
This file was deleted.

.github/workflows/docs_deploy.yml

+1-60
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ on:
1616
description: "Push to qiskit.org?"
1717
required: false
1818
type: boolean
19-
do_translatables:
20-
description: "Push translatable strings?"
21-
required: false
22-
type: boolean
2319

2420
jobs:
2521
build:
@@ -53,33 +49,8 @@ jobs:
5349
- name: Install dependencies
5450
run: tools/install_ubuntu_docs_dependencies.sh
5551

56-
# This is just to have tox create the environment, so we can use it to execute the tutorials.
57-
# We want to re-use it later for the build, hence 'tox run --notest' instead of 'tox devenv'.
58-
- name: Prepare Python environment
59-
run: tox run -e docs --notest
60-
61-
# The reason to use the custom script rather than letting 'nbsphinx' do its thing normally
62-
# within the Sphinx build is so that the execution process is the same as in the test CI.
63-
- name: Execute tutorials in place
64-
run: .tox/docs/bin/python tools/execute_tutorials.py docs/tutorials
65-
env:
66-
QISKIT_CELL_TIMEOUT: "300"
67-
6852
- name: Build documentation
69-
# We can skip re-installing the package, since we just did it a couple of steps ago.
70-
run: tox run -e docs --skip-pkg-install
71-
env:
72-
QISKIT_ENABLE_ANALYTICS: "true"
73-
# We've already built them.
74-
QISKIT_DOCS_BUILD_TUTORIALS: "never"
75-
DOCS_PROD_BUILD: "true"
76-
77-
- name: Build translatable strings
78-
run: tox run -e gettext
79-
env:
80-
# We've already built them.
81-
QISKIT_DOCS_BUILD_TUTORIALS: "never"
82-
DOCS_PROD_BUILD: "true"
53+
run: tox run -e docs
8354

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

94-
- name: Store translatable strings artifact
95-
uses: actions/upload-artifact@v3
96-
with:
97-
name: qiskit-translatables
98-
path: ./docs/locale/en/*
99-
if-no-files-found: error
100-
10165
deploy:
10266
if: github.event_name != 'workflow_dispatch' || inputs.do_deployment
10367
name: Deploy to qiskit.org
@@ -198,26 +162,3 @@ jobs:
198162
JOINED_PREFIXES: ${{ steps.choose.outputs.joined_prefixes }}
199163
RCLONE_KEY: ${{ secrets.ENCRYPTED_RCLONE_KEY}}
200164
RCLONE_IV: ${{ secrets.ENCRYPTED_RCLONE_IV }}
201-
202-
deploy_translatables:
203-
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)
204-
name: Push translatable strings
205-
needs: [build]
206-
runs-on: ubuntu-latest
207-
208-
steps:
209-
- uses: actions/checkout@v4
210-
with:
211-
path: 'qiskit'
212-
213-
- uses: actions/download-artifact@v3
214-
with:
215-
name: qiskit-translatables
216-
path: 'deploy'
217-
218-
- name: Deploy translations
219-
id: ssh_key
220-
run: qiskit/tools/deploy_translatable_strings.sh "${{ github.workspace }}/deploy"
221-
env:
222-
encrypted_deploy_po_branch_key: ${{ secrets.ENCRYPTED_DEPLOY_PO_BRANCH_KEY }}
223-
encrypted_deploy_po_branch_iv: ${{ secrets.ENCRYPTED_DEPLOY_PO_BRANCH_IV }}

azure-pipelines.yml

+2-12
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,6 @@ parameters:
5252
type: string
5353
default: "3.9"
5454

55-
- name: "tutorialsPythonVersion"
56-
displayName: "Version of Python to use to run the tutorials job"
57-
type: string
58-
default: "3.8"
59-
6055
# Sync with 'python-version' in '.github/workflows/docs_deploy.yml'.
6156
- name: "documentationPythonVersion"
6257
displayName: "Version of Python to use to build Sphinx documentation"
@@ -162,18 +157,13 @@ stages:
162157
testImages: true
163158

164159
# The rest of the PR pipeline is to test the oldest and newest supported
165-
# versions of Python, along with the integration tests (via the tutorials).
166-
# It's very rare for a failure to be specific to an intermediate version of
160+
# versions of Python. It's very rare for a failure to be specific to an intermediate version of
167161
# Python, so we just catch those in the cron-job pipeline to reduce the
168162
# amount of resources used.
169-
- stage: "Tutorials_and_Tests"
163+
- stage: "Tests"
170164
displayName: "Main tests"
171165
dependsOn: "Lint_Docs_Prelim_Tests"
172166
jobs:
173-
- template: ".azure/tutorials-linux.yml"
174-
parameters:
175-
pythonVersion: ${{ parameters.tutorialsPythonVersion }}
176-
177167
- template: ".azure/test-linux.yml"
178168
parameters:
179169
pythonVersion: ${{ parameters.maximumPythonVersion }}

docs/_static/images/1xp.png

-80.4 KB
Binary file not shown.

docs/_static/images/ibm_qlab.png

-80.7 KB
Binary file not shown.

docs/_static/images/strangeworks.png

-93.3 KB
Binary file not shown.

0 commit comments

Comments
 (0)