parent
24eb5e829e
commit
9d23c0bebe
|
@ -0,0 +1,48 @@
|
||||||
|
name: Docgen
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
- cidocs
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
timeout-minutes: 10
|
||||||
|
|
||||||
|
name: 'Generate & upload documentation'
|
||||||
|
runs-on: 'ubuntu-20.04'
|
||||||
|
continue-on-error: true
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
submodules: true
|
||||||
|
|
||||||
|
- uses: jiro4989/setup-nim-action@v1
|
||||||
|
with:
|
||||||
|
nim-version: 'stable'
|
||||||
|
|
||||||
|
- name: Generate doc
|
||||||
|
run: |
|
||||||
|
nim --version
|
||||||
|
nim buildDocs || true
|
||||||
|
|
||||||
|
- name: Clone the gh-pages branch
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
ref: gh-pages
|
||||||
|
path: subdoc
|
||||||
|
submodules: true
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Commit & push
|
||||||
|
run: |
|
||||||
|
rm -f subdoc/*
|
||||||
|
mv docs/* subdoc
|
||||||
|
cd subdoc
|
||||||
|
git add .
|
||||||
|
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
|
||||||
|
git config --global user.name = "${{ github.actor }}"
|
||||||
|
git commit -a -m "update docs"
|
||||||
|
git push origin gh-pages
|
|
@ -1,2 +1,2 @@
|
||||||
nimcache/
|
nimcache/
|
||||||
|
docs/
|
||||||
|
|
|
@ -24,7 +24,7 @@ requires "unittest2"
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [unittest2.html](https://status-im.github.io/nim-unittest2/docs/unittest2.html) documentation generated by `nim buildDocs`.
|
See [unittest2.html](https://status-im.github.io/nim-unittest2/unittest2.html) documentation generated by `nim buildDocs`.
|
||||||
|
|
||||||
Create a file that contains your unit tests:
|
Create a file that contains your unit tests:
|
||||||
|
|
||||||
|
|
1018
docs/nimdoc.out.css
1018
docs/nimdoc.out.css
File diff suppressed because one or more lines are too long
1039
docs/unittest2.html
1039
docs/unittest2.html
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue