documentation: move from tools to docs.md folder

2018-08-28 05:41:52 +02:00 · 2018-08-28 05:41:52 +02:00 · 367f5c52cd
parent 6f1e4a6481
commit 367f5c52cd
47 changed files with 8 additions and 3 deletions
--- a/tools/documentation/mkdocs/index.md
+++ b/tools/documentation/mkdocs/index.md
--- a/tools/documentation/mkdocs/about.md
+++ b/tools/documentation/mkdocs/about.md
--- a/tools/documentation/mkdocs/add_board.md
+++ b/tools/documentation/mkdocs/add_board.md
--- a/tools/documentation/mkdocs/arduino_api.md
+++ b/tools/documentation/mkdocs/arduino_api.md
--- a/tools/documentation/mkdocs/board_BLACK_F407VE.md
+++ b/tools/documentation/mkdocs/board_BLACK_F407VE.md
--- a/tools/documentation/mkdocs/board_BLACK_F407ZE.md
+++ b/tools/documentation/mkdocs/board_BLACK_F407ZE.md
--- a/tools/documentation/mkdocs/board_BLACK_F407ZG.md
+++ b/tools/documentation/mkdocs/board_BLACK_F407ZG.md
--- a/tools/documentation/mkdocs/board_BLUE_F103VE.md
+++ b/tools/documentation/mkdocs/board_BLUE_F103VE.md
--- a/tools/documentation/mkdocs/board_BLUE_F103ZE.md
+++ b/tools/documentation/mkdocs/board_BLUE_F103ZE.md
--- a/tools/documentation/mkdocs/board_BLUE_F103ZG.md
+++ b/tools/documentation/mkdocs/board_BLUE_F103ZG.md
--- a/tools/documentation/mkdocs/board_BluePill.md
+++ b/tools/documentation/mkdocs/board_BluePill.md
--- a/tools/documentation/mkdocs/board_DISCOVERY_F303VC.md
+++ b/tools/documentation/mkdocs/board_DISCOVERY_F303VC.md
--- a/tools/documentation/mkdocs/board_DISCOVERY_F407VG.md
+++ b/tools/documentation/mkdocs/board_DISCOVERY_F407VG.md
--- a/tools/documentation/mkdocs/board_DISCOVERY_F746NG.md
+++ b/tools/documentation/mkdocs/board_DISCOVERY_F746NG.md
--- a/tools/documentation/mkdocs/board_DISCOVERY_L053C8.md
+++ b/tools/documentation/mkdocs/board_DISCOVERY_L053C8.md
--- a/tools/documentation/mkdocs/board_F103ZE.md
+++ b/tools/documentation/mkdocs/board_F103ZE.md
--- a/tools/documentation/mkdocs/board_F103ZE1.md
+++ b/tools/documentation/mkdocs/board_F103ZE1.md
--- a/tools/documentation/mkdocs/board_F103ZF.md
+++ b/tools/documentation/mkdocs/board_F103ZF.md
--- a/tools/documentation/mkdocs/board_F103ZG.md
+++ b/tools/documentation/mkdocs/board_F103ZG.md
--- a/tools/documentation/mkdocs/board_Generic103RF.md
+++ b/tools/documentation/mkdocs/board_Generic103RF.md
--- a/tools/documentation/mkdocs/board_MapleMini_F103CB.md
+++ b/tools/documentation/mkdocs/board_MapleMini_F103CB.md
--- a/tools/documentation/mkdocs/board_Nucleo_F030R8.md
+++ b/tools/documentation/mkdocs/board_Nucleo_F030R8.md
--- a/tools/documentation/mkdocs/board_Nucleo_F103RB.md
+++ b/tools/documentation/mkdocs/board_Nucleo_F103RB.md
--- a/tools/documentation/mkdocs/board_Nucleo_F303RE.md
+++ b/tools/documentation/mkdocs/board_Nucleo_F303RE.md
--- a/tools/documentation/mkdocs/board_Nucleo_F401RE.md
+++ b/tools/documentation/mkdocs/board_Nucleo_F401RE.md
--- a/tools/documentation/mkdocs/board_Nucleo_F411RE.md
+++ b/tools/documentation/mkdocs/board_Nucleo_F411RE.md
--- a/tools/documentation/mkdocs/board_Nucleo_F767ZI.md
+++ b/tools/documentation/mkdocs/board_Nucleo_F767ZI.md
--- a/tools/documentation/mkdocs/board_Nucleo_L053R8.md
+++ b/tools/documentation/mkdocs/board_Nucleo_L053R8.md
--- a/tools/documentation/mkdocs/board_Nucleo_L152RE.md
+++ b/tools/documentation/mkdocs/board_Nucleo_L152RE.md
--- a/tools/documentation/mkdocs/board_Nucleo_L476RG.md
+++ b/tools/documentation/mkdocs/board_Nucleo_L476RG.md
--- a/tools/documentation/mkdocs/boards.md
+++ b/tools/documentation/mkdocs/boards.md
--- a/tools/documentation/mkdocs/boards.txt
+++ b/tools/documentation/mkdocs/boards.txt
--- a/tools/documentation/mkdocs/build_macros.md
+++ b/tools/documentation/mkdocs/build_macros.md
--- a/tools/documentation/mkdocs/i2c.md
+++ b/tools/documentation/mkdocs/i2c.md
--- a/tools/documentation/mkdocs/i2s.md
+++ b/tools/documentation/mkdocs/i2s.md
--- a/tools/documentation/mkdocs/libraries.md
+++ b/tools/documentation/mkdocs/libraries.md
--- a/tools/documentation/mkdocs/menu_options.md
+++ b/tools/documentation/mkdocs/menu_options.md
--- a/tools/documentation/mkdocs/sdio.md
+++ b/tools/documentation/mkdocs/sdio.md
--- a/tools/documentation/mkdocs/spi.md
+++ b/tools/documentation/mkdocs/spi.md
--- a/tools/documentation/mkdocs/stm32_hal.md
+++ b/tools/documentation/mkdocs/stm32_hal.md
--- a/tools/documentation/mkdocs/test.md
+++ b/tools/documentation/mkdocs/test.md
--- a/tools/documentation/mkdocs/uart.md
+++ b/tools/documentation/mkdocs/uart.md
--- a/tools/documentation/mkdocs/upload.md
+++ b/tools/documentation/mkdocs/upload.md
--- a/tools/documentation/mkdocs/usb_cdc.md
+++ b/tools/documentation/mkdocs/usb_cdc.md
--- a/tools/documentation/mkdocs/usb_msc.md
+++ b/tools/documentation/mkdocs/usb_msc.md
--- a/tools/documentation/mkdocs.yml
+++ b/tools/documentation/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
--- a/tools/documentation/build.bat
+++ b/tools/documentation/build.bat
@ -1 +0,0 @@
-mkdocs build -d ../../docs