Browse Source

Add flow to generate docs using MkDocs.

Source/Doc/Makefile:
  - add steps to 'deploy_mkdocs' target to generate MkDocs input.
  - change default image extension for GFM output to SVG.

Source/Doc/mkdocs.yaml:
  New config file for 'mkdocs build.'
pull/561/head
Rob Gowin 8 months ago
parent
commit
27864e8128
  1. 17
      Source/Doc/Makefile
  2. 16
      Source/Doc/mkdocs.yml

17
Source/Doc/Makefile

@ -31,12 +31,12 @@ all :: deploy
pandoc $< -f markdown -t dokuwiki -s -o $@ --default-image-extension=pdf
%.gfm : %.tmp
pandoc $< -f markdown -t gfm-yaml_metadata_block -s -o $@ --default-image-extension=pdf
pandoc $< -f markdown -t gfm-yaml_metadata_block -s -o $@ --default-image-extension=svg
%.txt : %.tmp
pandoc $< -f markdown -t plain -s -o $@ --default-image-extension=pdf
deploy :
deploy : deploy_mkdocs
cp Introduction.gfm "../../ReadMe.md"
cp Introduction.txt "../../ReadMe.txt"
cp Introduction.pdf "../../Doc/RomWBW Introduction.pdf"
@ -45,3 +45,16 @@ deploy :
cp Applications.pdf "../../Doc/RomWBW Applications.pdf"
cp Catalog.pdf "../../Doc/RomWBW Disk Catalog.pdf"
cp Hardware.pdf "../../Doc/RomWBW Hardware.pdf"
deploy_mkdocs : Introduction.gfm UserGuide.gfm SystemGuide.gfm Applications.gfm Catalog.gfm Hardware.gfm
rm -rf mkdocs
mkdir -p mkdocs/UserGuide/Graphics mkdocs/SystemGuide/Graphics
cp Introduction.gfm mkdocs/Introduction.md
cp UserGuide.gfm mkdocs/UserGuide.md
cp SystemGuide.gfm mkdocs/SystemGuide.md
cp Applications.gfm mkdocs/Applications.md
cp Catalog.gfm mkdocs/Catalog.md
cp Hardware.gfm mkdocs/Hardware.md
cp ReadMe.md mkdocs/README.md
cp Graphics/*.svg mkdocs/UserGuide/Graphics
cp Graphics/*.svg mkdocs/SystemGuide/Graphics

16
Source/Doc/mkdocs.yml

@ -0,0 +1,16 @@
site_name: RomWBW Documentation V3.6
repo_url: https://github.com/wwarthen/RomWBW
edit_uri: ""
docs_dir: mkdocs
nav:
- Introduction: Introduction.md
- User Guide: UserGuide.md
- System Guide: SystemGuide.md
- Applications: Applications.md
- Catalog: Catalog.md
- Hardware: Hardware.md
theme:
name: mkdocs
color_mode: auto
user_color_mode_toggle: true
navigation_depth: 3
Loading…
Cancel
Save