Skip to content

adds doc CI #141

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 26, 2025
Merged

adds doc CI #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a62afc1
adds doc CI
ringabout Mar 26, 2025
1b12132
progress
ringabout Mar 26, 2025
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
5 changes: 5 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,11 @@ jobs:
run: |
cd atlas
nim test

- name: Run Docs
run: |
cd atlas
nim docs

- name: Test install with Nimble
run: |
Expand Down
6 changes: 5 additions & 1 deletion config.nims
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import std/[strformat, strutils]

when defined(nimPreviewSlimSystem):
import std/syncio

--path:"$nim"
--path:"../sat/src/"

Expand Down Expand Up @@ -82,7 +86,7 @@ task test, "Runs all tests":
testerTask()

task docs, "build Atlas's docs":
exec "nim rst2html --putenv:atlasversion=$1 doc/atlas.md" % version
exec "nim rst2html --putenv:atlasversion=$1 --d:nimPreviewSlimSystem doc/atlas.md" % version

# begin Nimble config (version 2)
# when withDir(thisDir(), system.fileExists("nimble.paths")):
Expand Down
Loading