Glassvision/JuliaFEM.jl
1
0
Fork 0
mirror of https://github.com/JuliaFEM/JuliaFEM.jl.git synced 2026-08-06 04:21:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(docs): update make.jl

Browse Source 
docs/make.jl | 52 ++++++++++++++++++++++------------------------------  1 file changed, 22 insertions(+), 30 deletions(-)
This commit is contained in:
Jukka Aho
2026-05-09 16:30:24 +03:00
parent 482af34fea
commit 2a3b11592f
1 changed files with 22 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/make.jl
+22 -30
View File
@@ -1,37 +1,29 @@
# Modern Documenter.jl build script for JuliaFEM API documentation
# Generates markdown files for Quarto integration
using Documenter using Documenter
using DocumenterMarkdown
using JuliaFEM using JuliaFEM
# Get directories
juliafem_dir = dirname(@__DIR__)
website_dir = joinpath(juliafem_dir, "juliafem.github.io")
build_dir = joinpath(website_dir, "api") # Build markdown directly to api/ directory
# Simple pages structure - just API documentation
pages = [
"Home" => "index.md",
"API Reference" => "api.md",
]
# Build API documentation as markdown
makedocs( makedocs(
sitename = "JuliaFEM API", sitename = "JuliaFEM.jl",
authors = "JuliaFEM Team", authors = "JuliaFEM Team",
modules = [JuliaFEM], modules = [JuliaFEM],
format = Documenter.HTML(;
# Source and build directories prettyurls = get(ENV, "CI", nothing) == "true",
source = "api", # Use docs/api/ for source size_threshold = nothing,
build = build_dir, # Build markdown to website api/ directory size_threshold_warn = nothing,
),
# Format: Generate markdown instead of HTML pages = [
format = DocumenterMarkdown.Markdown(), "Home" => "index.md",
"Elements and multiphysics" => "elements_multiphysics_teaser.md",
# Documentation options "Thermo-elastic walkthrough" => "thermo_elastic_walkthrough.md",
"Choosing an assembler" => "assembler_choice.md",
"Legacy module" => "legacy.md",
"Developer" => [
"Architecture layers" => "developer/architecture_layers.md",
"Repository layout" => "repository_layout.md",
],
"API Reference" => "api.md",
],
checkdocs = :none, checkdocs = :none,
doctest = false, doctest = false,
linkcheck = false, linkcheck = false,
warnonly = [:missing_docs, :cross_references], warnonly = [:missing_docs, :cross_references],
) )