feature: add mkdocs-material documentation site with CI deployment
Generate comprehensive documentation for all 173 source units and integrate mkdocs-material into the build toolchain. Documentation covers kernel core, x86 architecture, drivers, applications, and all subsystems with a tabbed navigation structure. - Add mkdocs.yml with material theme, mermaid support, and tabbed nav - Add doc/index.md landing page - Generate doc/src/ markdown for every Pascal unit in src/ - Reorganize planning docs into doc/planning/ - Add compat, lvglh, and toolchain doc sections - Update Dockerfile to install python3 and mkdocs-material (pinned <2) - Replace pasdoc-based compile_docs.sh with mkdocs build --strict - Add compile_docs.sh to the main build pipeline in compile.sh - Add deploy-docs step in .drone.yml with host volume mount to nginx - Add site/.gitkeep for build output directory
This commit is contained in:
1 parent
7157a57513
commit
26e2fd947e
209 files changed
+16996
-13
No files matched your search
@@ -30,6 +30,7 @@ declare -a run_steps=(
|
||||
"compile_sources.sh" "Failed to compile FPC Sources!"
|
||||
"compile_link.sh" "Failed linking!"
|
||||
"compile_isogen.sh" "Failed to create ISO!"
|
||||
"compile_docs.sh" "Failed to generate documentation!"
|
||||
)
|
||||
|
||||
for ((i=0; i<${#run_steps[@]}; i+=2))
|
||||
|
||||
+15
-11
@@ -4,14 +4,18 @@ echo "======================="
|
||||
echo " "
|
||||
echo "Generating Documentation..."
|
||||
echo " "
|
||||
echo "Dowloading Pasdoc..."
|
||||
wget https://github.com/pasdoc/pasdoc/releases/download/v0.16.0/pasdoc-0.16.0-linux-x86_64.tar.gz -O pasdoc.tar.gz
|
||||
echo "Extracting Pasdoc..."
|
||||
tar -xf pasdoc.tar.gz
|
||||
echo "Creating doc output directory..."
|
||||
mkdir ./doc
|
||||
echo "Removing old docs"
|
||||
rm -rf ./doc/*
|
||||
echo "Generating Docs..."
|
||||
./pasdoc/bin/pasdoc -N "Asuro" -T "Asuro OS Documentation" -O "html" -E ./doc/ -S sources.list --use-tipue-search
|
||||
echo "Docgen finished."
|
||||
|
||||
if ! command -v mkdocs &> /dev/null; then
|
||||
echo "Installing mkdocs-material..."
|
||||
pip install --quiet "mkdocs>=1.6,<2" mkdocs-material
|
||||
fi
|
||||
|
||||
echo "Building static site..."
|
||||
mkdocs build --strict
|
||||
|
||||
if [ $? -eq 0 ]; then
|
||||
echo "Documentation built successfully. Output: site/"
|
||||
else
|
||||
echo "Documentation build failed."
|
||||
exit 1
|
||||
fi
|
||||
Reference in new issue
Block a user