Skip to content

Commit

Permalink
CI: run docs, publish docs
Browse files Browse the repository at this point in the history
  • Loading branch information
timotheecour committed Oct 13, 2020
1 parent a24a381 commit 1320683
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 1 deletion.
20 changes: 20 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -181,3 +181,23 @@ jobs:
run: |
cd fusion
nimble test
- name: docs
run: |
cd fusion
nimble docs
- name: Deploy docs
# to view docs on your own fork: push a gh-pages branch on your fork,
# enable gh-pages in your fork
# and remove `github.ref == 'refs/heads/master'` below
if: |
github.event_name == 'push' && github.ref == 'refs/heads/master' &&
matrix.target.os == 'linux' && matrix.target.cpu == 'amd64' &&
matrix.branch == 'devel'
uses: crazy-max/ghaction-github-pages@v1
with:
build_dir: fusion/htmldocs
target_branch: gh-pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 1 addition & 1 deletion fusion.nimble
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ requires "nim >= 1.0.0"
task docs, "":
# can customize, eg:
# exec "nim r src/fusion/docutils " & srcDir & " --outdir:htmldocs2 -d:foo"
exec "nim r src/fusion/docutils " & srcDir
exec "nim c -r src/fusion/docutils " & srcDir
1 change: 1 addition & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Nim Fusion
docs: https://nim-lang.github.io/fusion/theindex.html

Fusion contains Nim modules that are to be bundled with the Nim installation in order to give us something like the "Nim distribution".
Fusion fullfills multiple purposes:
Expand Down

0 comments on commit 1320683

Please sign in to comment.