From edac84a19bac6ba1dde78fb3366d60fc5d9d80f8 Mon Sep 17 00:00:00 2001 From: Tilman Hinnerichs Date: Fri, 5 Apr 2024 14:09:42 +0200 Subject: [PATCH] Add src to Docuemnter doc check --- .github/workflows/check_docs.yml | 4 +++- .github/workflows/src/index.md | 15 +++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/src/index.md diff --git a/.github/workflows/check_docs.yml b/.github/workflows/check_docs.yml index 44bd323..9e1b01a 100644 --- a/.github/workflows/check_docs.yml +++ b/.github/workflows/check_docs.yml @@ -29,10 +29,12 @@ jobs: julia --project=docs -e ' using Documenter, HerbCore; makedocs( + source=".github/workflow/src", sitename="HerbCore.jl", modules=[HerbCore], format=Documenter.HTML(), doctest=true, - warnonly=[:doctest, :missing_docs] + warnonly=[:doctest, :missing_docs], + pages=["index.md"] ); ' diff --git a/.github/workflows/src/index.md b/.github/workflows/src/index.md new file mode 100644 index 0000000..d1b647f --- /dev/null +++ b/.github/workflows/src/index.md @@ -0,0 +1,15 @@ +# [HerbCore.jl Documentation](@id HerbCore_docs) + +```@meta +CurrentModule=HerbCore +``` + +```@autodocs +Modules = [HerbCore] +Order = [:type, :const, :macro, :function] +``` + +## Index + +```@index +```