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

Publishing workflow #742

Merged
merged 89 commits into from
Dec 28, 2022
Merged
Show file tree
Hide file tree
Changes from 87 commits
Commits
Show all changes
89 commits
Select commit Hold shift + click to select a range
d0701be
add deploy_doc.yml
Edoardo-Pedicillo Nov 16, 2022
f86ad5b
rtd theme --> furo theme in conf.py
MatteoRobbiati Nov 15, 2022
725a034
restoring ipynb outputs
MatteoRobbiati Nov 15, 2022
3fd38ec
typo
Edoardo-Pedicillo Nov 16, 2022
84dee3b
typo
Edoardo-Pedicillo Nov 16, 2022
6770078
add python version
Edoardo-Pedicillo Nov 16, 2022
d45ab4e
change usable workflow name
Edoardo-Pedicillo Nov 16, 2022
b1c6a29
typo
Edoardo-Pedicillo Nov 16, 2022
be38055
typo
Edoardo-Pedicillo Nov 16, 2022
7fa3527
typo
Edoardo-Pedicillo Nov 16, 2022
d696fd4
trigger workflow
Edoardo-Pedicillo Nov 16, 2022
41130f4
trigger workflow
Edoardo-Pedicillo Nov 16, 2022
15fcd02
Update .github/workflows/deploy_doc.yml
Edoardo-Pedicillo Nov 16, 2022
01388e6
Update .github/workflows/deploy_doc.yml
Edoardo-Pedicillo Nov 16, 2022
db89e14
trigger workflow
Edoardo-Pedicillo Nov 16, 2022
43d39a2
trigger workflow
Edoardo-Pedicillo Nov 16, 2022
eb2743b
change branch
Edoardo-Pedicillo Nov 16, 2022
4d8755a
add workflow dispatch
Edoardo-Pedicillo Nov 16, 2022
95a1715
add workflow dispatch: fix typo
Edoardo-Pedicillo Nov 17, 2022
de41b52
add workflow dispatch: fix typo
Edoardo-Pedicillo Nov 17, 2022
b3f9a7b
remove test_workflow from triggers
Edoardo-Pedicillo Nov 17, 2022
ed0e819
workflow dispatch: fixing problems
Edoardo-Pedicillo Nov 17, 2022
c4a5ec1
workflow dispatch: fixing problems
Edoardo-Pedicillo Nov 17, 2022
acdd129
workflow dispatch: fixing problems
Edoardo-Pedicillo Nov 17, 2022
5359750
workflow dispatch: fixing problems
Edoardo-Pedicillo Nov 17, 2022
4d26fc5
remove blank line
Edoardo-Pedicillo Nov 17, 2022
a6c0775
change branch to 'documentation'
Edoardo-Pedicillo Dec 1, 2022
edd24c6
add package manager
Edoardo-Pedicillo Dec 1, 2022
499950d
add dependency-path
Edoardo-Pedicillo Dec 2, 2022
9b14a98
change branch in main
Edoardo-Pedicillo Dec 7, 2022
10fd090
explore github.event_name
Edoardo-Pedicillo Dec 7, 2022
10a24c0
fix bug
Edoardo-Pedicillo Dec 7, 2022
853032c
explore github.ref
Edoardo-Pedicillo Dec 7, 2022
0746f9a
add label latest
Edoardo-Pedicillo Dec 7, 2022
5f58486
add label stable
Edoardo-Pedicillo Dec 7, 2022
16fe43d
use bash for the labels
Edoardo-Pedicillo Dec 7, 2022
7852e99
typo
Edoardo-Pedicillo Dec 7, 2022
d60d586
add job generate-docs
Edoardo-Pedicillo Dec 7, 2022
30158f8
typo
Edoardo-Pedicillo Dec 7, 2022
af1815b
fix bug
Edoardo-Pedicillo Dec 7, 2022
0416543
typo
Edoardo-Pedicillo Dec 7, 2022
8dd0f43
typo
Edoardo-Pedicillo Dec 7, 2022
822bcfc
fix bugs
Edoardo-Pedicillo Dec 7, 2022
20ee179
add job new-artifact
Edoardo-Pedicillo Dec 7, 2022
b8be559
add debugging lines
Edoardo-Pedicillo Dec 7, 2022
cb75533
rename artifact folder
Edoardo-Pedicillo Dec 7, 2022
07131fd
typo
Edoardo-Pedicillo Dec 7, 2022
c9aeaf0
typo
Edoardo-Pedicillo Dec 7, 2022
eb0316e
add debugging line
Edoardo-Pedicillo Dec 7, 2022
8d35700
unzip folder
Edoardo-Pedicillo Dec 7, 2022
a1646fa
typo
Edoardo-Pedicillo Dec 7, 2022
3229e16
typo
Edoardo-Pedicillo Dec 7, 2022
f69a19a
use tar instead of unzip
Edoardo-Pedicillo Dec 7, 2022
d1f13de
typo
Edoardo-Pedicillo Dec 7, 2022
08a4f44
extract archive in onether folder
Edoardo-Pedicillo Dec 7, 2022
ff3b8f6
typo
Edoardo-Pedicillo Dec 7, 2022
b2b270c
generate the remaning documentation
Edoardo-Pedicillo Dec 9, 2022
8ad239f
fix bugs
Edoardo-Pedicillo Dec 9, 2022
65dea61
generate remaning doc, general case
Edoardo-Pedicillo Dec 9, 2022
a0621b4
typo
Edoardo-Pedicillo Dec 9, 2022
365ad30
minor fixes
Edoardo-Pedicillo Dec 9, 2022
2e1dd71
minor fixes
Edoardo-Pedicillo Dec 9, 2022
5f3ad42
minor fixes
Edoardo-Pedicillo Dec 9, 2022
a218db3
debugging
Edoardo-Pedicillo Dec 9, 2022
908f56d
fix bugs
Edoardo-Pedicillo Dec 9, 2022
dfc35dc
upload artifact
Edoardo-Pedicillo Dec 9, 2022
e137805
typo
Edoardo-Pedicillo Dec 9, 2022
78cb1a5
move new-artifact to deploy-sphinx-docs-to-ghpages
Edoardo-Pedicillo Dec 9, 2022
c615637
add comment
Edoardo-Pedicillo Dec 9, 2022
c76d380
fix bugs
Edoardo-Pedicillo Dec 9, 2022
d69b497
fix tag problem
Edoardo-Pedicillo Dec 12, 2022
27bf5eb
restore file
Edoardo-Pedicillo Dec 12, 2022
e5199a0
debugging
Edoardo-Pedicillo Dec 12, 2022
94462b1
change label conditions
Edoardo-Pedicillo Dec 12, 2022
f4f2682
change tag lable condition
Edoardo-Pedicillo Dec 12, 2022
898fa66
fix tags
Edoardo-Pedicillo Dec 12, 2022
80830f1
clean workflow
Edoardo-Pedicillo Dec 12, 2022
ca0c018
remove 'Error' label
Edoardo-Pedicillo Dec 13, 2022
c654092
change branch
Edoardo-Pedicillo Dec 14, 2022
88a09fa
minor fixes
Edoardo-Pedicillo Dec 14, 2022
1075f5c
removed package name and logo from doc frontpage
MatteoRobbiati Dec 13, 2022
62dd34c
Change reusable workflow location to qiboteam
alecandido Dec 20, 2022
55f2fb4
update deploy_doc.yml
Edoardo-Pedicillo Dec 20, 2022
548d78e
correct bug
Edoardo-Pedicillo Dec 20, 2022
f7b4098
Change name of docs publishing workflow
alecandido Dec 20, 2022
6adbf87
restore label
Edoardo-Pedicillo Dec 20, 2022
1ac2b13
pre-commit
Edoardo-Pedicillo Dec 27, 2022
cec4ca9
Merge branch 'master' into master
MatteoRobbiati Dec 28, 2022
c9d055a
Now `conf.py` is the same of the one in `qiboteam/qibo`
MatteoRobbiati Dec 28, 2022
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
37 changes: 37 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Deploy docs

on:
workflow_dispatch:
push:
branches: [master]
tags:
- "*"

jobs:
evaluate-label:
runs-on: ubuntu-latest
outputs:
label: ${{ steps.label_step.outputs.version}}
steps:
- name: checks for the label
id: label_step
run: |
if [[ "${{ github.ref }}" == "refs/heads/master" ]]; then
echo "version=latest" >> $GITHUB_OUTPUT
fi
if [[ "${{ github.ref_type }}" == "branch" ]] && [[ "${{ github.ref }}" != "refs/heads/master" ]]; then
exit 1
fi
if [[ "${{ github.ref_type }}" == "tag" ]]; then
echo "version=stable" >> $GITHUB_OUTPUT
fi

deploy-docs:
needs: [evaluate-label]
uses: qiboteam/workflows/.github/workflows/deploy-ghpages-latest-stable.yml@main
with:
python-version: 3.9
package-manager: "pip"
dependency-path: "**/setup.py"
trigger-label: "${{needs.evaluate-label.outputs.label}}"
project: qibo
10 changes: 6 additions & 4 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,15 @@
from recommonmark.transform import AutoStructify

sys.path.insert(0, os.path.abspath(".."))
import qibo

# -- Project information -----------------------------------------------------

project = "qibo"
project = " "
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please follow the approach in #745, or simply remove those changes in this PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to remove them, since I am making these changes in dedicated PR.

copyright = "2020-2022 by the Qibo team"
author = "The Qibo team"

# The full version, including alpha/beta/rc tags
# release = qibo.__version__
release = " "


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -70,7 +69,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#

html_theme = "furo"

html_theme_options = {
Expand All @@ -84,6 +83,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".

html_static_path = ["_static"]


Expand All @@ -110,4 +110,6 @@ def setup(app):
app.add_css_file("css/style.css")


# html_logo = "logo.png"

html_show_sourcelink = False