From 2a3b11592fb9c445dd20cb1aac830cde5536c7d6 Mon Sep 17 00:00:00 2001 From: Jukka Aho Date: Sat, 9 May 2026 16:30:24 +0300 Subject: [PATCH] refactor(docs): update make.jl docs/make.jl | 52 ++++++++++++++++++++++------------------------------ 1 file changed, 22 insertions(+), 30 deletions(-) --- docs/make.jl | 52 ++++++++++++++++++++++------------------------------ 1 file changed, 22 insertions(+), 30 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 4bf8cb0..6c8dc5d 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,37 +1,29 @@ -# Modern Documenter.jl build script for JuliaFEM API documentation -# Generates markdown files for Quarto integration - using Documenter -using DocumenterMarkdown 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( - sitename = "JuliaFEM API", - authors = "JuliaFEM Team", - modules = [JuliaFEM], - - # Source and build directories - source = "api", # Use docs/api/ for source - build = build_dir, # Build markdown to website api/ directory - - # Format: Generate markdown instead of HTML - format = DocumenterMarkdown.Markdown(), - - # Documentation options + sitename = "JuliaFEM.jl", + authors = "JuliaFEM Team", + modules = [JuliaFEM], + format = Documenter.HTML(; + prettyurls = get(ENV, "CI", nothing) == "true", + size_threshold = nothing, + size_threshold_warn = nothing, + ), + pages = [ + "Home" => "index.md", + "Elements and multiphysics" => "elements_multiphysics_teaser.md", + "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, - doctest = false, + doctest = false, linkcheck = false, - warnonly = [:missing_docs, :cross_references], + warnonly = [:missing_docs, :cross_references], )