Skip to content

Commit

Permalink
Deploy the documentation of the main branch (#818)
Browse files Browse the repository at this point in the history
* Deploy the documentation of the main branch

* Correct spelling
  • Loading branch information
Halbaroth authored Sep 19, 2023
1 parent a5e0fe9 commit 2d7d271
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ env:
jobs:
# For any push and PR, build the documentation from the ocaml comments
# If this build fails, the documentation workflow stops
# If it succed, an artifact is made with the generated documentation
# If it succeeds, an artifact is made with the generated documentation
# (html format only). This artifact is used in the deploying job
ocaml_docs:
name: OCaml documentation
Expand Down Expand Up @@ -95,7 +95,7 @@ jobs:

# On PR, or push on next/main, build the sphinx general documentation
# If this build fails, the documentation workflow stops
# If it succed, an artifact is made with the generated documentation
# If it succeeds, an artifact is made with the generated documentation
# This artifact is used in the deploying job
sphinx_docs:
name: Sphinx documentation
Expand Down Expand Up @@ -130,12 +130,12 @@ jobs:
path: docs/sphinx_docs/_build


# For every push on next, retrieve ocaml and sphinx documentation
# For every push on main, retrieve ocaml and sphinx documentation
# and publish them on gh-pages branch
deploy_docs:
name: Deploy documentation

if: github.ref == 'refs/heads/next'
if: github.ref == 'refs/heads/main'

needs:
- ocaml_docs
Expand Down

0 comments on commit 2d7d271

Please sign in to comment.