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

docs: use pytket-docs-theming submodule #153

Merged
merged 45 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
3e827f3
add .venv to .gitignore
CalMacCQ Aug 27, 2024
c23ae04
remove legacy docs directory
CalMacCQ Aug 27, 2024
a4e3072
rename intro.txt -> index.rst
CalMacCQ Aug 27, 2024
59d3816
add docs theming submodule
CalMacCQ Aug 27, 2024
82cd247
delete custom.css
CalMacCQ Aug 27, 2024
bcc950b
use latest submodule commit
CalMacCQ Aug 27, 2024
7199963
delete outdated submodule
CalMacCQ Aug 27, 2024
fe7f67a
add updated submodule
CalMacCQ Aug 27, 2024
87930b6
add bash script to build the docs
CalMacCQ Aug 27, 2024
6147e79
update README
CalMacCQ Aug 27, 2024
5db35ff
update README once more
CalMacCQ Aug 27, 2024
2eea52a
delete duplicate submodule dir
CalMacCQ Aug 27, 2024
e9282fb
update bash script
CalMacCQ Aug 27, 2024
8f4cf4d
Use updated submodule with extensions_deps
CalMacCQ Aug 28, 2024
aae823b
add dependency files to .gitignore
CalMacCQ Aug 28, 2024
9b0631e
add docs install script
CalMacCQ Aug 28, 2024
c00bfe0
add install script
CalMacCQ Aug 28, 2024
efd4f13
update submodule to avoid build warnings
CalMacCQ Aug 28, 2024
f92a6fd
update README
CalMacCQ Aug 28, 2024
de12ff2
add some comments
CalMacCQ Aug 28, 2024
d1990d1
add some comments
CalMacCQ Aug 28, 2024
30fdb76
add the correct title of the project
CalMacCQ Aug 28, 2024
73d2a40
update comment
CalMacCQ Aug 28, 2024
7836974
minor cleanup
CalMacCQ Aug 28, 2024
704ee3f
Fix typo in bash script
CalMacCQ Aug 28, 2024
0cf0c20
remove instructions from README, link to theming repo
CalMacCQ Sep 3, 2024
2bca1a6
rename extensions_deps to extensions
CalMacCQ Sep 3, 2024
40580bd
update theming submodule
CalMacCQ Sep 3, 2024
52c7d63
add link to instructions
CalMacCQ Sep 3, 2024
14ffb0c
fix github link in navbar
CalMacCQ Sep 4, 2024
2d4e588
update comment
CalMacCQ Sep 4, 2024
caa1fe0
improve build-docs.sh script
CalMacCQ Sep 4, 2024
be6456a
add left sidebar links
CalMacCQ Sep 4, 2024
b76e5a0
update docs.yml
CalMacCQ Oct 1, 2024
14ce84f
update docs build in build_and_test.yml
CalMacCQ Oct 1, 2024
1b4e53c
fix installation of docs dependencies
CalMacCQ Oct 1, 2024
265ee71
remove duplicate name
CalMacCQ Oct 1, 2024
0e4540a
try to fix poetry issue
CalMacCQ Oct 1, 2024
11c7f35
try another way to fix poetry issue
CalMacCQ Oct 1, 2024
71a3097
another attempt
CalMacCQ Oct 1, 2024
084c3ab
try again to fix docs build
CalMacCQ Oct 1, 2024
2e650d5
use latest docs theming
CalMacCQ Oct 1, 2024
1190705
update install docs dependencies once again
CalMacCQ Oct 1, 2024
586ac2e
try yet again
CalMacCQ Oct 1, 2024
6f9e3e6
try using submodules: true
CalMacCQ Oct 2, 2024
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
27 changes: 18 additions & 9 deletions .github/workflows/build_and_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: '0'
submodules: true
- run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* +refs/heads/*:refs/remotes/origin/*
- name: Set up Python 3.10
uses: actions/setup-python@v5
Expand Down Expand Up @@ -66,15 +67,20 @@ jobs:
with:
name: artefact-${{ matrix.os }}
path: wheelhouse/
- name: install poetry
run: pip install poetry
- name: Install docs dependencies
if: (matrix.os == 'ubuntu-22.04') && (github.event_name == 'pull_request' || github.event_name == 'schedule' )
run: |
pip install -r .github/workflows/docs/requirements.txt
cd docs
bash ./install.sh
for w in `find wheelhouse/ -type f -name "*.whl"` ; do poetry install $w ; done
- name: Build docs
if: (matrix.os == 'ubuntu-22.04') && (github.event_name == 'pull_request' || github.event_name == 'schedule' )
timeout-minutes: 20
run: |
./.github/workflows/docs/check-build-docs
cd docs
poetry run bash ./build-docs.sh


publish_to_pypi:
Expand Down Expand Up @@ -111,24 +117,27 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: '0'
- name: Set up Python 3.10
submodules: true
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: '3.10'
python-version: '3.11'
- name: Download all wheels
uses: actions/download-artifact@v4
with:
path: wheelhouse
- name: Install pip, wheel
run: pip install -U pip wheel
- name: Install poetry
run: pip install poetry
- name: Install extension
run: for w in `find wheelhouse/ -type f -name "*.whl"` ; do pip install $w ; done
run: for w in `find wheelhouse/ -type f -name "*.whl"` ; do poetry install $w ; done
- name: Install docs dependencies
run: |
pip install -r .github/workflows/docs/requirements.txt
cd docs
bash ./install.sh
- name: Build docs
timeout-minutes: 20
run: |
cd .github/workflows/docs
mkdir extensions
./build-docs -d ${GITHUB_WORKSPACE}/.github/workflows/docs/extensions/api
cd docs
poetry run bash ./build-docs.sh
29 changes: 13 additions & 16 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,27 @@ on:
schedule:
# 04:00 every Tuesday morning
- cron: '0 4 * * 2'

jobs:
docs:
name: build docs
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.10
with:
submodules: true
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Upgrade pip and install wheel
run: pip install --upgrade pip wheel
- name: Install pytket-cutensornet
run: pip install .
python-version: '3.11'
- name: install poetry
run: pip install poetry
- name: Install docs dependencies
run: |
pip install -r .github/workflows/docs/requirements.txt
run: cd docs && bash install.sh
- name: Install pytket cutensornet
run: cd docs && poetry run pip install ../.
- name: Test building docs
timeout-minutes: 20
timeout-minutes: 10
run: |
cd .github/workflows/docs
mkdir extensions
./build-docs -d ${GITHUB_WORKSPACE}/.github/workflows/docs/extensions
- uses: actions/upload-artifact@v4
with:
name: pytket-extension-docs
path: .github/workflows/docs/extensions/
cd docs
poetry run bash build-docs.sh
Binary file removed .github/workflows/docs/Quantinuum_logo_black.png
Binary file not shown.
Binary file removed .github/workflows/docs/Quantinuum_logo_white.png
Binary file not shown.
114 changes: 0 additions & 114 deletions .github/workflows/docs/build-docs

This file was deleted.

10 changes: 0 additions & 10 deletions .github/workflows/docs/check-build-docs

This file was deleted.

149 changes: 0 additions & 149 deletions .github/workflows/docs/conf.py

This file was deleted.

6 changes: 0 additions & 6 deletions .github/workflows/docs/requirements.txt

This file was deleted.

Loading
Loading