Skip to content
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
27 changes: 27 additions & 0 deletions .github/workflows/Documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Documentation

on:
push:
branches:
- main
tags: '*'
pull_request:

# The reusable documentation workflow requests these permissions for its
# build job; declare them here so the call starts even when the repo's
# default GITHUB_TOKEN permissions are read-only.
permissions:
actions: write
contents: write
pull-requests: write
statuses: write

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}

jobs:
build-and-deploy-docs:
name: "Documentation"
uses: "SciML/.github/.github/workflows/documentation.yml@v1"
secrets: "inherit"
8 changes: 8 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
SciMLTesting = "09d9d899-5365-40a9-917a-5f67fddea283"

[compat]
Documenter = "1"
SciMLTesting = "2"
julia = "1.10"
20 changes: 20 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
using Documenter
using SciMLTesting

makedocs(;
modules = [SciMLTesting],
authors = "SciML Contributors",
sitename = "SciMLTesting.jl",
format = Documenter.HTML(;
prettyurls = get(ENV, "CI", "false") == "true",
canonical = "https://docs.sciml.ai/SciMLTesting/stable/",
),
pages = [
"Home" => "index.md",
"API" => "api.md",
],
)

deploydocs(;
repo = "github.com/SciML/SciMLTesting.jl.git",
)
28 changes: 26 additions & 2 deletions docs/src/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
# API Reference

```@autodocs
Modules = [SciMLTesting]
## Test dispatch

```@docs
read_test_groups
current_group
detect_sublibrary_group
run_tests
run_everything
```

## Test environments

```@docs
activate_group_env
develop_sources!
with_clean_persistent_tasks_sources
```

## Quality assurance

```@docs
run_qa
run_explicit_imports
run_api_docs
public_api_names
public_reexports
```
28 changes: 28 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# SciMLTesting.jl

```@docs
SciMLTesting
```

## Usage

A package's `test/runtests.jl` replaces its hand-written `GROUP` ladder with a
single call to [`run_tests`](@ref):

```julia
using SciMLTesting

run_tests()
```

The groups a package supports are declared in `test/test_groups.toml`. A group
that has its own environment can be selected by name through the `GROUP`
environment variable, which is what CI lanes use:

```sh
GROUP=Core julia --project -e 'using Pkg; Pkg.test()'
```

## API

See the [API Reference](@ref) for the full list of exported helpers.
Loading