Skip to content

Commit

Permalink
Refactor the documentation (#397)
Browse files Browse the repository at this point in the history
* removed old documentation

* removed old documentation

* update

* Update doc/introduction/introduction.rst

Co-authored-by: Tom Bromley <49409390+trbromley@users.noreply.github.com>

* add ci

* add squeezer demo

* fix docs building

* fix typo

* update intersphinx

Co-authored-by: Tom Bromley <49409390+trbromley@users.noreply.github.com>
  • Loading branch information
josh146 and trbromley committed Jun 24, 2020
1 parent 2bdc0ca commit 046c09f
Show file tree
Hide file tree
Showing 70 changed files with 172 additions and 11,845 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/docs.yml
@@ -0,0 +1,15 @@
name: "Documentation check"
on:
- pull_request

jobs:
sphinx:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: josh146/sphinx-action@master
with:
docs-folder: "doc/"
repo-token: "${{ secrets.GITHUB_TOKEN }}"
pre-build-command: "apt install -y graphviz && pip3 install -r requirements.txt && pip3 install ."
build-command: "sphinx-build -b html . _build -W --keep-going"
2 changes: 0 additions & 2 deletions .gitignore
Expand Up @@ -13,9 +13,7 @@ notebooks/*
examples/.ipynb_checkpoints/*
.pytest_cache/*
pytest/.pytest_cache/
examples_apps/*.html
doc/_static/thumbs/*
doc/tutorials_apps/*
!doc/_static/code.png
doc/code/api/*
Pipfile*
Expand Down
32 changes: 30 additions & 2 deletions doc/_static/xanadu_gallery.css
Expand Up @@ -50,18 +50,46 @@ thumbnail with its default link Background color */
text-decoration: none;
}

.sphx-glr-thumbcontainer a.external {
bottom: 0;
display: block;
left: 0;
padding: 150px 10px 0;
position: absolute;
right: 0;
top: 0;
color: #575757;
}

/* Next one is to avoid Sphinx traditional theme to cover all the
thumbnail with its default link Background color */
.sphx-glr-thumbcontainer a.external:hover {
background-color: transparent;
color: #575757;
text-decoration: none;
}

.sphx-glr-thumbcontainer p {
margin: 0 0 .1em 0;
}
.sphx-glr-thumbcontainer .figure {
margin: 10px;
width: 160px;
}

.sphx-glr-thumbcontainer img {
display: inline;
max-height: 160px;
width: 160px;
max-height: 120px;
max-width: 160px;
width: auto;
position: absolute;
top: 0;
bottom: 25%;
left: 0;
right: 0;
margin: auto;
}

.sphx-glr-thumbcontainer[tooltip]:hover:after {
background: rgba(0, 0, 0, 0.8);
-webkit-border-radius: 5px;
Expand Down
94 changes: 0 additions & 94 deletions doc/algorithms/boson_sampling.rst

This file was deleted.

114 changes: 0 additions & 114 deletions doc/algorithms/gate_teleportation.rst

This file was deleted.

0 comments on commit 046c09f

Please sign in to comment.