diff --git a/docs/AlphaIndex.md b/docs/AlphaIndex.md new file mode 100644 index 0000000..602002c --- /dev/null +++ b/docs/AlphaIndex.md @@ -0,0 +1,11 @@ +# Alphabetical Index + +An index of Functions, Modules, and Constants by name. + +[M](#m) + +## M + +- [`miter_profile()`](metalib.scad#module-miter_profile) Mod – Creates a miter profile +- [`miter_tubes()`](metalib.scad#module-miter_tubes) Mod – Generates a sequence of mitered tubes + diff --git a/docs/TOC.md b/docs/TOC.md new file mode 100644 index 0000000..824fc55 --- /dev/null +++ b/docs/TOC.md @@ -0,0 +1,16 @@ +# Table of Contents + +## List of Files + +**Metal:** + +- [metalib.scad](#1-metalibscad) ([docs](metalib.scad)) +Metal, metalon, profile, and geometry. + +## 1. [metalib.scad](metalib.scad) + +Metal, metalon, profile, and geometry. + - [`miter_profile()`](metalib.scad#module-miter_profile) Mod – Creates a miter profile + - [`miter_tubes()`](metalib.scad#module-miter_tubes) Mod – Generates a sequence of mitered tubes + + diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md new file mode 100644 index 0000000..902c9bc --- /dev/null +++ b/docs/_Sidebar.md @@ -0,0 +1,13 @@ +## Indices + +[Table of Contents](TOC) +[Function Index](AlphaIndex) +[Topics Index](Topics) +[Tutorials](Tutorials) + +## List of Files: + +**Metal:** + +- [metalib.scad](metalib.scad) + diff --git a/gen_doc.sh b/gen_doc.sh index a147a89..3af6165 100755 --- a/gen_doc.sh +++ b/gen_doc.sh @@ -1 +1 @@ -openscad-docsgen -m -I -P "Metalib" -f +openscad-docsgen -m -I -P "Metalib" -f -p wiki -i -t -m -s