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

CI: run docs, publish docs #26

Merged
merged 2 commits into from
Oct 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -181,3 +181,24 @@ jobs:
run: |
cd fusion
nimble test

- name: docs
if: matrix.branch == 'devel'
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