From 5dbfef1bbe5dca438fbb15d54ea304e96dde8cda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Dante=20Ursini?= Date: Thu, 13 Feb 2025 13:58:23 -0300 Subject: [PATCH] Gendoc change --- .openscad_docsgen_rc | 7 +++++++ doc/CheatSheet.md | 9 +++++++++ doc/_Sidebar.md | 14 ++++++++++++++ run.sh | 3 ++- 4 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 doc/CheatSheet.md create mode 100644 doc/_Sidebar.md diff --git a/.openscad_docsgen_rc b/.openscad_docsgen_rc index bb17041..554b900 100644 --- a/.openscad_docsgen_rc +++ b/.openscad_docsgen_rc @@ -2,3 +2,10 @@ DocsDirectory: doc/ TargetProfile: githubwiki ProjectName: Battery Holder GenerateDocs: Files, TOC, Index, Topics, CheatSheet, Sidebar +SidebarHeader: + ## Indices + . +SidebarMiddle: + [Tutorials](Tutorials) +DefineHeader(BulletList): Side Effects +DefineHeader(Table;Headers=Anchor Name|Position): Extra Anchors diff --git a/doc/CheatSheet.md b/doc/CheatSheet.md new file mode 100644 index 0000000..c2dedd7 --- /dev/null +++ b/doc/CheatSheet.md @@ -0,0 +1,9 @@ +# Battery Holder Cheat Sheet + +## LibFile: battery-holder.scad + +### Section: Batteries + +>[battery\_case](battery-holder.scad#module-battery_case)(n); + + diff --git a/doc/_Sidebar.md b/doc/_Sidebar.md new file mode 100644 index 0000000..4109e94 --- /dev/null +++ b/doc/_Sidebar.md @@ -0,0 +1,14 @@ +## Indices + +[Table of Contents](TOC) +[Function Index](AlphaIndex) +[Topics Index](Topics) +[Cheat Sheet](CheatSheet) +[Tutorials](Tutorials) + +## List of Files: + +**Batteries:** + +- [battery-holder.scad](battery-holder.scad) + diff --git a/run.sh b/run.sh index 76590a8..e83c189 100755 --- a/run.sh +++ b/run.sh @@ -18,7 +18,8 @@ run_docsgen() { source docgen/bin/activate || { echo "Failed to activate virtual environment. Make sure 'docgen' exists."; return 1; } fi echo "Running openscad-docsgen..." - openscad-docsgen -m -I -P "Metalib" -f -p wiki -i -t -m -s + #openscad-docsgen -m -I -P "Metalib" -f -p wiki -i -t -m -s + openscad-docsgen -f echo "Documentation generation completed." }