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

template applied #21

Merged
merged 1 commit into from
Aug 28, 2024
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
6 changes: 6 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
coverage:
status:
project:
default:
target: 90% # the required coverage value
threshold: 0.5% # the leniency in hitting the target
16 changes: 16 additions & 0 deletions .github/workflows/Register.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Register Package
on:
workflow_dispatch:
inputs:
version:
description: Version to register or component to bump
required: true
jobs:
register:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: julia-actions/RegisterAction@latest
with:
token: ${{ secrets.GITHUB_TOKEN }}
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@


# AdversarialRobustness

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaTrustworthyAI.github.io/AdversarialRobustness.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaTrustworthyAI.github.io/AdversarialRobustness.jl/dev/)
[![Build Status](https://github.com/JuliaTrustworthyAI/AdversarialRobustness.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/JuliaTrustworthyAI/AdversarialRobustness.jl/actions/workflows/CI.yml?query=branch%3Amaster)
[![Coverage](https://codecov.io/gh/JuliaTrustworthyAI/AdversarialRobustness.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaTrustworthyAI/AdversarialRobustness.jl)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaTrustworthyAI.github.io/AdversarialRobustness.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaTrustworthyAI.github.io/AdversarialRobustness.jl/dev/) [![Build Status](https://github.com/JuliaTrustworthyAI/AdversarialRobustness.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaTrustworthyAI/AdversarialRobustness.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/JuliaTrustworthyAI/AdversarialRobustness.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaTrustworthyAI/AdversarialRobustness.jl) [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
19 changes: 19 additions & 0 deletions README.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
format:
commonmark:
variant: -raw_html+tex_math_dollars
wrap: none
mermaid-format: png
crossref:
fig-prefix: Figure
tbl-prefix: Table
output: asis
---

# AdversarialRobustness

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaTrustworthyAI.github.io/AdversarialRobustness.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaTrustworthyAI.github.io/AdversarialRobustness.jl/dev/)
[![Build Status](https://github.com/JuliaTrustworthyAI/AdversarialRobustness.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaTrustworthyAI/AdversarialRobustness.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/JuliaTrustworthyAI/AdversarialRobustness.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaTrustworthyAI/AdversarialRobustness.jl)
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
15 changes: 15 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
project:
title: "AdversarialRobustness.jl"
execute-dir: project
render:
- "!docs/src/*.md"
crossref:
fig-prefix: Figure
tbl-prefix: Table
resource-path:
- docs/src/assets
format:
commonmark:
variant: -raw_html+tex_math_dollars
wrap: preserve
mermaid-format: png
51 changes: 48 additions & 3 deletions docs/make.jl
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,15 +1,60 @@
#!/usr/bin/env julia
#
#

if "--help" ∈ ARGS
println(
"""
docs/make.jl

Render the documentation using Quarto with optional arguments

Arguments
* `--help` - print this help and exit without rendering the documentation
* `--prettyurls` – toggle the prettyurls part to true (which is otherwise only true on CI)
* `--project` - specify the project name (default: `$(@__DIR__)`)
* `--quarto` – run the Quarto notebooks from the `tutorials/` folder before generating the documentation
this has to be run locally at least once for the `tutorials/*.md` files to exist that are included in
the documentation (see `--exclude-tutorials`) for the alternative.
If they are generated once they are cached accordingly.
Then you can spare time in the rendering by not passing this argument.
If quarto is not run, some tutorials are generated as empty files, since they
are referenced from within the documentation.
""",
)
exit(0)
end

# (a) Specify project
using Pkg
if any(contains.(ARGS, "--project"))
@assert sum(contains.(ARGS, "--project")) == 1 "Only one environment can be specified using the `--project` argument."
_path =
ARGS[findall(contains.(ARGS, "--project"))][1] |>
x -> replace(x, "--project=" => "")
Pkg.activate(_path)
else
Pkg.activate(@__DIR__)
end

# (b) Did someone say render?
if "--quarto" ∈ ARGS
@info "Rendering docs"
run(`quarto render $(joinpath(@__DIR__, "src"))`)
end

using AdversarialRobustness
using Documenter

DocMeta.setdocmeta!(AdversarialRobustness, :DocTestSetup, :(using AdversarialRobustness); recursive=true)

makedocs(;
modules=[AdversarialRobustness],
authors="Rithik Appachi Senthilkumar",
authors="Rithik Appachi Senthilkumar and contributors",
sitename="AdversarialRobustness.jl",
format=Documenter.HTML(;
canonical="https://JuliaTrustworthyAI.github.io/AdversarialRobustness.jl",
edit_link="master",
edit_link="main",
assets=String[],
),
pages=[
Expand All @@ -19,5 +64,5 @@ makedocs(;

deploydocs(;
repo="github.com/JuliaTrustworthyAI/AdversarialRobustness.jl",
devbranch="master",
devbranch="main",
)
14 changes: 14 additions & 0 deletions docs/src/index.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```@meta
CurrentModule = AdversarialRobustness
```

# AdversarialRobustness

Documentation for [AdversarialRobustness](https://github.com/JuliaTrustworthyAI/AdversarialRobustness.jl).

```@index
```

```@autodocs
Modules = [AdversarialRobustness]
```
Loading