[WIP] Migrate to MkDocs

roboticslab-uc3m · Nov 14, 2023 · 2c35fce · 2c35fce
1 parent 7fce094
commit 2c35fce
Show file tree

Hide file tree

Showing 111 changed files with 579 additions and 318 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -0,0 +1,31 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+    - mkdocs # temporary
+    paths-ignore:
+    - README.md
+    - CONTRIBUTING.md
+    - CMakeLists.txt
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: fkirc/skip-duplicate-actions@v5
+      with:
+        cancel_others: 'true'
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0 # for the 'Last updated' timestamp
+    - name: Install requirements
+      run: pip install -r requirements.txt
+    - name: Build site
+      run: mkdocs build
+    - uses: crazy-max/ghaction-github-pages@v4
+      with:
+        build_dir: site
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
diff --git a/.github/workflows/gitbook.yml b/.github/workflows/gitbook.yml
diff --git a/.gitignore b/.gitignore
@@ -1,22 +1,12 @@
-# .gitignore
 ## Files we want to have locally, but do not want to push to remote
 
 ## Editor swap files
 *~
 *.swp
 *.orig
 
-## CMake and C/C++
+## CMake build system
 **/build*/
-CMakeLists.txt.user
-*.cproject
-*.project
-tags
 
-## doxygen
-doc/html
-doc/doxygen_sqlite3.db
-
-## gitbook generated
-/_book/
-/node_modules/
+## mkdocs generated
+/site/
diff --git a/README.md b/README.md
@@ -22,18 +22,19 @@ Please read the Developer Manual's [Asking Questions](https://robots.uc3m.es/dev
 
 It is useful to serve on `localhost` to modify the website and see changes locally.
 
-1. From the root of the project, run the following command (which is universal for all [Gitbook (legacy)](https://github.com/GitbookIO/gitbook)-based projects):
+1. From the root of the project, run the following command:
 
    ```bash
-   gitbook serve # command builds and serves; for installing required plugins, before first  run please: gitbook install
+   pip install -r requirements.txt
+   mkdocs serve
    ```
 
-1. You can now browse the site at the default location: <http://127.0.0.1:4000>
+1. You can now browse the site at the default location: <http://127.0.0.1:8000>
 
 ### How to upload changes to GitHub
 
-This project is managed as any project on [GitHub](https://www.github.com). You may use [Git](https://git-scm.com) or even the GitHub web interface, both on which you can find many tutorials online. The following points are specific to the [Gitbook (legacy)](https://github.com/asrob-uc3m/actas/issues/148#issuecomment-449748350) mechanism used:
+This project is managed as any project on [GitHub](https://www.github.com). You may use [Git](https://git-scm.com) or even the GitHub web interface, both on which you can find many tutorials online. The following points are specific to the MkDocs mechanism used:
 
-1. Please **do not upload** the `_book/` folder. It is auto-generated locally, and the same should happen on the Gitbook (legacy) servers.
+1. Please **do not upload** the `site/` folder. It is auto-generated locally, and the same should happen on the MkDocs servers.
 
 1. It is safe to `git push` to any upstream branch, just remember that what is on `master` is what will be actually rendered as the website.
diff --git a/SUMMARY.md b/SUMMARY.md
diff --git a/book.json b/book.json
diff --git a/additional-resources.md → docs/additional-resources.md b/additional-resources.md → docs/additional-resources.md
diff --git a/architecture.md → docs/architecture.md b/architecture.md → docs/architecture.md
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
diff --git a/docs/assets/roboticslab.svg b/docs/assets/roboticslab.svg
diff --git a/connectors.md → docs/connectors.md b/connectors.md → docs/connectors.md
diff --git a/csv/bom.csv → docs/csv/bom.csv b/csv/bom.csv → docs/csv/bom.csv
diff --git a/csv/deprecated/dh-transformations.csv → docs/csv/deprecated/dh-transformations.csv b/csv/deprecated/dh-transformations.csv → docs/csv/deprecated/dh-transformations.csv
diff --git a/csv/deprecated/dh-trunk.csv → docs/csv/deprecated/dh-trunk.csv b/csv/deprecated/dh-trunk.csv → docs/csv/deprecated/dh-trunk.csv
diff --git a/csv/dh-fetch.csv → docs/csv/dh-fetch.csv b/csv/dh-fetch.csv → docs/csv/dh-fetch.csv
diff --git a/csv/dh-head-transformations.csv → docs/csv/dh-head-transformations.csv b/csv/dh-head-transformations.csv → docs/csv/dh-head-transformations.csv
diff --git a/csv/dh-head.csv → docs/csv/dh-head.csv b/csv/dh-head.csv → docs/csv/dh-head.csv
diff --git a/csv/dh-leftArm.csv → docs/csv/dh-leftArm.csv b/csv/dh-leftArm.csv → docs/csv/dh-leftArm.csv
diff --git a/csv/dh-leftLeg.csv → docs/csv/dh-leftLeg.csv b/csv/dh-leftLeg.csv → docs/csv/dh-leftLeg.csv
diff --git a/csv/dh-rightArm.csv → docs/csv/dh-rightArm.csv b/csv/dh-rightArm.csv → docs/csv/dh-rightArm.csv
diff --git a/csv/dh-rightLeg.csv → docs/csv/dh-rightLeg.csv b/csv/dh-rightLeg.csv → docs/csv/dh-rightLeg.csv
diff --git a/csv/dh-root-head.csv → docs/csv/dh-root-head.csv b/csv/dh-root-head.csv → docs/csv/dh-root-head.csv
diff --git a/csv/dh-root-leftArm.csv → docs/csv/dh-root-leftArm.csv b/csv/dh-root-leftArm.csv → docs/csv/dh-root-leftArm.csv
diff --git a/csv/dh-root-leftLeg.csv → docs/csv/dh-root-leftLeg.csv b/csv/dh-root-leftLeg.csv → docs/csv/dh-root-leftLeg.csv
diff --git a/csv/dh-root-rightArm.csv → docs/csv/dh-root-rightArm.csv b/csv/dh-root-rightArm.csv → docs/csv/dh-root-rightArm.csv
diff --git a/csv/dh-root-rightLeg.csv → docs/csv/dh-root-rightLeg.csv b/csv/dh-root-rightLeg.csv → docs/csv/dh-root-rightLeg.csv
diff --git a/csv/dynamic_info_absolute.csv → docs/csv/dynamic_info_absolute.csv b/csv/dynamic_info_absolute.csv → docs/csv/dynamic_info_absolute.csv
diff --git a/csv/dynamic_info_relative.csv → docs/csv/dynamic_info_relative.csv b/csv/dynamic_info_relative.csv → docs/csv/dynamic_info_relative.csv
diff --git a/csv/editable/motores.ods → docs/csv/editable/motores.ods b/csv/editable/motores.ods → docs/csv/editable/motores.ods
diff --git a/csv/lengths.csv → docs/csv/lengths.csv b/csv/lengths.csv → docs/csv/lengths.csv
diff --git a/csv/motores-motores.csv → docs/csv/motores-motores.csv b/csv/motores-motores.csv → docs/csv/motores-motores.csv
diff --git a/csv/motores-protecciones-brazos.csv → docs/csv/motores-protecciones-brazos.csv b/csv/motores-protecciones-brazos.csv → docs/csv/motores-protecciones-brazos.csv
diff --git a/csv/motores-protecciones-piernas.csv → docs/csv/motores-protecciones-piernas.csv b/csv/motores-protecciones-piernas.csv → docs/csv/motores-protecciones-piernas.csv
diff --git a/csv/motores-transmision.csv → docs/csv/motores-transmision.csv b/csv/motores-transmision.csv → docs/csv/motores-transmision.csv
diff --git a/csv/teo-center-of-masses.csv → docs/csv/teo-center-of-masses.csv b/csv/teo-center-of-masses.csv → docs/csv/teo-center-of-masses.csv