From 367f5c52cde31a3ceda54192c309f5133b791d3a Mon Sep 17 00:00:00 2001 From: Daniel Fekete Date: Tue, 28 Aug 2018 05:41:52 +0200 Subject: [PATCH] documentation: move from tools to docs.md folder --- .../documentation/mkdocs/index.md => docs.md/README.md | 0 {tools/documentation/mkdocs => docs.md}/about.md | 0 {tools/documentation/mkdocs => docs.md}/add_board.md | 0 {tools/documentation/mkdocs => docs.md}/arduino_api.md | 0 .../mkdocs => docs.md}/board_BLACK_F407VE.md | 0 .../mkdocs => docs.md}/board_BLACK_F407ZE.md | 0 .../mkdocs => docs.md}/board_BLACK_F407ZG.md | 0 .../mkdocs => docs.md}/board_BLUE_F103VE.md | 0 .../mkdocs => docs.md}/board_BLUE_F103ZE.md | 0 .../mkdocs => docs.md}/board_BLUE_F103ZG.md | 0 .../documentation/mkdocs => docs.md}/board_BluePill.md | 0 .../mkdocs => docs.md}/board_DISCOVERY_F303VC.md | 0 .../mkdocs => docs.md}/board_DISCOVERY_F407VG.md | 0 .../mkdocs => docs.md}/board_DISCOVERY_F746NG.md | 0 .../mkdocs => docs.md}/board_DISCOVERY_L053C8.md | 0 .../documentation/mkdocs => docs.md}/board_F103ZE.md | 0 .../documentation/mkdocs => docs.md}/board_F103ZE1.md | 0 .../documentation/mkdocs => docs.md}/board_F103ZF.md | 0 .../documentation/mkdocs => docs.md}/board_F103ZG.md | 0 .../mkdocs => docs.md}/board_Generic103RF.md | 0 .../mkdocs => docs.md}/board_MapleMini_F103CB.md | 0 .../mkdocs => docs.md}/board_Nucleo_F030R8.md | 0 .../mkdocs => docs.md}/board_Nucleo_F103RB.md | 0 .../mkdocs => docs.md}/board_Nucleo_F303RE.md | 0 .../mkdocs => docs.md}/board_Nucleo_F401RE.md | 0 .../mkdocs => docs.md}/board_Nucleo_F411RE.md | 0 .../mkdocs => docs.md}/board_Nucleo_F767ZI.md | 0 .../mkdocs => docs.md}/board_Nucleo_L053R8.md | 0 .../mkdocs => docs.md}/board_Nucleo_L152RE.md | 0 .../mkdocs => docs.md}/board_Nucleo_L476RG.md | 0 {tools/documentation/mkdocs => docs.md}/boards.md | 0 {tools/documentation/mkdocs => docs.md}/boards.txt | 0 .../documentation/mkdocs => docs.md}/build_macros.md | 0 {tools/documentation/mkdocs => docs.md}/i2c.md | 0 {tools/documentation/mkdocs => docs.md}/i2s.md | 0 {tools/documentation/mkdocs => docs.md}/libraries.md | 0 .../documentation/mkdocs => docs.md}/menu_options.md | 0 {tools/documentation/mkdocs => docs.md}/sdio.md | 0 {tools/documentation/mkdocs => docs.md}/spi.md | 0 {tools/documentation/mkdocs => docs.md}/stm32_hal.md | 0 {tools/documentation/mkdocs => docs.md}/test.md | 0 {tools/documentation/mkdocs => docs.md}/uart.md | 0 {tools/documentation/mkdocs => docs.md}/upload.md | 0 {tools/documentation/mkdocs => docs.md}/usb_cdc.md | 0 {tools/documentation/mkdocs => docs.md}/usb_msc.md | 0 tools/documentation/mkdocs.yml => mkdocs.yml | 10 ++++++++-- tools/documentation/build.bat | 1 - 47 files changed, 8 insertions(+), 3 deletions(-) rename tools/documentation/mkdocs/index.md => docs.md/README.md (100%) rename {tools/documentation/mkdocs => docs.md}/about.md (100%) rename {tools/documentation/mkdocs => docs.md}/add_board.md (100%) rename {tools/documentation/mkdocs => docs.md}/arduino_api.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_BLACK_F407VE.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_BLACK_F407ZE.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_BLACK_F407ZG.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_BLUE_F103VE.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_BLUE_F103ZE.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_BLUE_F103ZG.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_BluePill.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_DISCOVERY_F303VC.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_DISCOVERY_F407VG.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_DISCOVERY_F746NG.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_DISCOVERY_L053C8.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_F103ZE.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_F103ZE1.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_F103ZF.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_F103ZG.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_Generic103RF.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_MapleMini_F103CB.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_Nucleo_F030R8.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_Nucleo_F103RB.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_Nucleo_F303RE.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_Nucleo_F401RE.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_Nucleo_F411RE.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_Nucleo_F767ZI.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_Nucleo_L053R8.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_Nucleo_L152RE.md (100%) rename {tools/documentation/mkdocs => docs.md}/board_Nucleo_L476RG.md (100%) rename {tools/documentation/mkdocs => docs.md}/boards.md (100%) rename {tools/documentation/mkdocs => docs.md}/boards.txt (100%) rename {tools/documentation/mkdocs => docs.md}/build_macros.md (100%) rename {tools/documentation/mkdocs => docs.md}/i2c.md (100%) rename {tools/documentation/mkdocs => docs.md}/i2s.md (100%) rename {tools/documentation/mkdocs => docs.md}/libraries.md (100%) rename {tools/documentation/mkdocs => docs.md}/menu_options.md (100%) rename {tools/documentation/mkdocs => docs.md}/sdio.md (100%) rename {tools/documentation/mkdocs => docs.md}/spi.md (100%) rename {tools/documentation/mkdocs => docs.md}/stm32_hal.md (100%) rename {tools/documentation/mkdocs => docs.md}/test.md (100%) rename {tools/documentation/mkdocs => docs.md}/uart.md (100%) rename {tools/documentation/mkdocs => docs.md}/upload.md (100%) rename {tools/documentation/mkdocs => docs.md}/usb_cdc.md (100%) rename {tools/documentation/mkdocs => docs.md}/usb_msc.md (100%) rename tools/documentation/mkdocs.yml => mkdocs.yml (91%) delete mode 100644 tools/documentation/build.bat diff --git a/tools/documentation/mkdocs/index.md b/docs.md/README.md similarity index 100% rename from tools/documentation/mkdocs/index.md rename to docs.md/README.md diff --git a/tools/documentation/mkdocs/about.md b/docs.md/about.md similarity index 100% rename from tools/documentation/mkdocs/about.md rename to docs.md/about.md diff --git a/tools/documentation/mkdocs/add_board.md b/docs.md/add_board.md similarity index 100% rename from tools/documentation/mkdocs/add_board.md rename to docs.md/add_board.md diff --git a/tools/documentation/mkdocs/arduino_api.md b/docs.md/arduino_api.md similarity index 100% rename from tools/documentation/mkdocs/arduino_api.md rename to docs.md/arduino_api.md diff --git a/tools/documentation/mkdocs/board_BLACK_F407VE.md b/docs.md/board_BLACK_F407VE.md similarity index 100% rename from tools/documentation/mkdocs/board_BLACK_F407VE.md rename to docs.md/board_BLACK_F407VE.md diff --git a/tools/documentation/mkdocs/board_BLACK_F407ZE.md b/docs.md/board_BLACK_F407ZE.md similarity index 100% rename from tools/documentation/mkdocs/board_BLACK_F407ZE.md rename to docs.md/board_BLACK_F407ZE.md diff --git a/tools/documentation/mkdocs/board_BLACK_F407ZG.md b/docs.md/board_BLACK_F407ZG.md similarity index 100% rename from tools/documentation/mkdocs/board_BLACK_F407ZG.md rename to docs.md/board_BLACK_F407ZG.md diff --git a/tools/documentation/mkdocs/board_BLUE_F103VE.md b/docs.md/board_BLUE_F103VE.md similarity index 100% rename from tools/documentation/mkdocs/board_BLUE_F103VE.md rename to docs.md/board_BLUE_F103VE.md diff --git a/tools/documentation/mkdocs/board_BLUE_F103ZE.md b/docs.md/board_BLUE_F103ZE.md similarity index 100% rename from tools/documentation/mkdocs/board_BLUE_F103ZE.md rename to docs.md/board_BLUE_F103ZE.md diff --git a/tools/documentation/mkdocs/board_BLUE_F103ZG.md b/docs.md/board_BLUE_F103ZG.md similarity index 100% rename from tools/documentation/mkdocs/board_BLUE_F103ZG.md rename to docs.md/board_BLUE_F103ZG.md diff --git a/tools/documentation/mkdocs/board_BluePill.md b/docs.md/board_BluePill.md similarity index 100% rename from tools/documentation/mkdocs/board_BluePill.md rename to docs.md/board_BluePill.md diff --git a/tools/documentation/mkdocs/board_DISCOVERY_F303VC.md b/docs.md/board_DISCOVERY_F303VC.md similarity index 100% rename from tools/documentation/mkdocs/board_DISCOVERY_F303VC.md rename to docs.md/board_DISCOVERY_F303VC.md diff --git a/tools/documentation/mkdocs/board_DISCOVERY_F407VG.md b/docs.md/board_DISCOVERY_F407VG.md similarity index 100% rename from tools/documentation/mkdocs/board_DISCOVERY_F407VG.md rename to docs.md/board_DISCOVERY_F407VG.md diff --git a/tools/documentation/mkdocs/board_DISCOVERY_F746NG.md b/docs.md/board_DISCOVERY_F746NG.md similarity index 100% rename from tools/documentation/mkdocs/board_DISCOVERY_F746NG.md rename to docs.md/board_DISCOVERY_F746NG.md diff --git a/tools/documentation/mkdocs/board_DISCOVERY_L053C8.md b/docs.md/board_DISCOVERY_L053C8.md similarity index 100% rename from tools/documentation/mkdocs/board_DISCOVERY_L053C8.md rename to docs.md/board_DISCOVERY_L053C8.md diff --git a/tools/documentation/mkdocs/board_F103ZE.md b/docs.md/board_F103ZE.md similarity index 100% rename from tools/documentation/mkdocs/board_F103ZE.md rename to docs.md/board_F103ZE.md diff --git a/tools/documentation/mkdocs/board_F103ZE1.md b/docs.md/board_F103ZE1.md similarity index 100% rename from tools/documentation/mkdocs/board_F103ZE1.md rename to docs.md/board_F103ZE1.md diff --git a/tools/documentation/mkdocs/board_F103ZF.md b/docs.md/board_F103ZF.md similarity index 100% rename from tools/documentation/mkdocs/board_F103ZF.md rename to docs.md/board_F103ZF.md diff --git a/tools/documentation/mkdocs/board_F103ZG.md b/docs.md/board_F103ZG.md similarity index 100% rename from tools/documentation/mkdocs/board_F103ZG.md rename to docs.md/board_F103ZG.md diff --git a/tools/documentation/mkdocs/board_Generic103RF.md b/docs.md/board_Generic103RF.md similarity index 100% rename from tools/documentation/mkdocs/board_Generic103RF.md rename to docs.md/board_Generic103RF.md diff --git a/tools/documentation/mkdocs/board_MapleMini_F103CB.md b/docs.md/board_MapleMini_F103CB.md similarity index 100% rename from tools/documentation/mkdocs/board_MapleMini_F103CB.md rename to docs.md/board_MapleMini_F103CB.md diff --git a/tools/documentation/mkdocs/board_Nucleo_F030R8.md b/docs.md/board_Nucleo_F030R8.md similarity index 100% rename from tools/documentation/mkdocs/board_Nucleo_F030R8.md rename to docs.md/board_Nucleo_F030R8.md diff --git a/tools/documentation/mkdocs/board_Nucleo_F103RB.md b/docs.md/board_Nucleo_F103RB.md similarity index 100% rename from tools/documentation/mkdocs/board_Nucleo_F103RB.md rename to docs.md/board_Nucleo_F103RB.md diff --git a/tools/documentation/mkdocs/board_Nucleo_F303RE.md b/docs.md/board_Nucleo_F303RE.md similarity index 100% rename from tools/documentation/mkdocs/board_Nucleo_F303RE.md rename to docs.md/board_Nucleo_F303RE.md diff --git a/tools/documentation/mkdocs/board_Nucleo_F401RE.md b/docs.md/board_Nucleo_F401RE.md similarity index 100% rename from tools/documentation/mkdocs/board_Nucleo_F401RE.md rename to docs.md/board_Nucleo_F401RE.md diff --git a/tools/documentation/mkdocs/board_Nucleo_F411RE.md b/docs.md/board_Nucleo_F411RE.md similarity index 100% rename from tools/documentation/mkdocs/board_Nucleo_F411RE.md rename to docs.md/board_Nucleo_F411RE.md diff --git a/tools/documentation/mkdocs/board_Nucleo_F767ZI.md b/docs.md/board_Nucleo_F767ZI.md similarity index 100% rename from tools/documentation/mkdocs/board_Nucleo_F767ZI.md rename to docs.md/board_Nucleo_F767ZI.md diff --git a/tools/documentation/mkdocs/board_Nucleo_L053R8.md b/docs.md/board_Nucleo_L053R8.md similarity index 100% rename from tools/documentation/mkdocs/board_Nucleo_L053R8.md rename to docs.md/board_Nucleo_L053R8.md diff --git a/tools/documentation/mkdocs/board_Nucleo_L152RE.md b/docs.md/board_Nucleo_L152RE.md similarity index 100% rename from tools/documentation/mkdocs/board_Nucleo_L152RE.md rename to docs.md/board_Nucleo_L152RE.md diff --git a/tools/documentation/mkdocs/board_Nucleo_L476RG.md b/docs.md/board_Nucleo_L476RG.md similarity index 100% rename from tools/documentation/mkdocs/board_Nucleo_L476RG.md rename to docs.md/board_Nucleo_L476RG.md diff --git a/tools/documentation/mkdocs/boards.md b/docs.md/boards.md similarity index 100% rename from tools/documentation/mkdocs/boards.md rename to docs.md/boards.md diff --git a/tools/documentation/mkdocs/boards.txt b/docs.md/boards.txt similarity index 100% rename from tools/documentation/mkdocs/boards.txt rename to docs.md/boards.txt diff --git a/tools/documentation/mkdocs/build_macros.md b/docs.md/build_macros.md similarity index 100% rename from tools/documentation/mkdocs/build_macros.md rename to docs.md/build_macros.md diff --git a/tools/documentation/mkdocs/i2c.md b/docs.md/i2c.md similarity index 100% rename from tools/documentation/mkdocs/i2c.md rename to docs.md/i2c.md diff --git a/tools/documentation/mkdocs/i2s.md b/docs.md/i2s.md similarity index 100% rename from tools/documentation/mkdocs/i2s.md rename to docs.md/i2s.md diff --git a/tools/documentation/mkdocs/libraries.md b/docs.md/libraries.md similarity index 100% rename from tools/documentation/mkdocs/libraries.md rename to docs.md/libraries.md diff --git a/tools/documentation/mkdocs/menu_options.md b/docs.md/menu_options.md similarity index 100% rename from tools/documentation/mkdocs/menu_options.md rename to docs.md/menu_options.md diff --git a/tools/documentation/mkdocs/sdio.md b/docs.md/sdio.md similarity index 100% rename from tools/documentation/mkdocs/sdio.md rename to docs.md/sdio.md diff --git a/tools/documentation/mkdocs/spi.md b/docs.md/spi.md similarity index 100% rename from tools/documentation/mkdocs/spi.md rename to docs.md/spi.md diff --git a/tools/documentation/mkdocs/stm32_hal.md b/docs.md/stm32_hal.md similarity index 100% rename from tools/documentation/mkdocs/stm32_hal.md rename to docs.md/stm32_hal.md diff --git a/tools/documentation/mkdocs/test.md b/docs.md/test.md similarity index 100% rename from tools/documentation/mkdocs/test.md rename to docs.md/test.md diff --git a/tools/documentation/mkdocs/uart.md b/docs.md/uart.md similarity index 100% rename from tools/documentation/mkdocs/uart.md rename to docs.md/uart.md diff --git a/tools/documentation/mkdocs/upload.md b/docs.md/upload.md similarity index 100% rename from tools/documentation/mkdocs/upload.md rename to docs.md/upload.md diff --git a/tools/documentation/mkdocs/usb_cdc.md b/docs.md/usb_cdc.md similarity index 100% rename from tools/documentation/mkdocs/usb_cdc.md rename to docs.md/usb_cdc.md diff --git a/tools/documentation/mkdocs/usb_msc.md b/docs.md/usb_msc.md similarity index 100% rename from tools/documentation/mkdocs/usb_msc.md rename to docs.md/usb_msc.md diff --git a/tools/documentation/mkdocs.yml b/mkdocs.yml similarity index 91% rename from tools/documentation/mkdocs.yml rename to mkdocs.yml index 7b61b4b..8ef6bef 100644 --- a/tools/documentation/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,13 @@ +# Use with mkdocs documentation generator https://www.mkdocs.org/ +# docs.md => docs +# To build run: +# mkdocs build + site_name: STM32GENERIC -docs_dir: mkdocs +docs_dir: docs.md +site_dir: docs pages: -- Installation: index.md +- Installation: README.md - Uploading: upload.md - Documentation: - Menu options: menu_options.md diff --git a/tools/documentation/build.bat b/tools/documentation/build.bat deleted file mode 100644 index 6a2852c..0000000 --- a/tools/documentation/build.bat +++ /dev/null @@ -1 +0,0 @@ -mkdocs build -d ../../docs