Gendoc change

This commit is contained in:
Sébastien Dante Ursini 2025-02-13 13:58:23 -03:00
parent 91cc305c40
commit 5dbfef1bbe
4 changed files with 32 additions and 1 deletions

View File

@ -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

9
doc/CheatSheet.md Normal file
View File

@ -0,0 +1,9 @@
# Battery Holder Cheat Sheet
## LibFile: battery-holder.scad
### Section: Batteries
><code>[battery\_case](battery-holder.scad#module-battery_case)(n);</code>

14
doc/_Sidebar.md Normal file
View File

@ -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)

3
run.sh
View File

@ -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."
}