🎨 Fixes autorope#20, use relative links for pages and assets, prefere…

…d way for mkdocs
Benvii · Dec 6, 2021 · 8c177df · 8c177df
1 parent a1ec2f5
commit 8c177df
Show file tree

Hide file tree

Showing 16 changed files with 38 additions and 36 deletions.
diff --git a/docs/dev_guide/docs.md b/docs/dev_guide/docs.md
@@ -34,7 +34,7 @@ becomes:
 STEERING_LEFT_PWM = 500
 ```
 
-when edited. You will adjust these later in the [calibrate](/guide/calibrate/) section.
+when edited. You will adjust these later in the [calibrate](../guide/calibrate.md) section.
 
 ### Configure I2C PCA9685
 
@@ -182,4 +182,4 @@ Your ~/mycar/manage.py, ~/mycar/config.py and other files will change with this
 
 -------
 
-### Next [calibrate your car](/guide/calibrate/).
+### Next [calibrate your car](../guide/calibrate.md).
diff --git a/docs/guide/build_hardware.md b/docs/guide/build_hardware.md
@@ -165,7 +165,7 @@ When attaching the roll cage to the top plate, ensure that the nubs on the top p
 
 ### Step 4: Connect Servo Shield to Raspberry Pi
 
-***note: this is not necessary if you are using direct control with [RaspberyPi GPIO pins](https://docs.donkeycar.com/parts/rc/) or are using a Robohat MM1 board***
+***note: this is not necessary if you are using direct control with [RaspberyPi GPIO pins](../parts/rc.md) or are using a Robohat MM1 board***
 
 You could do this after attaching the Raspberry Pi to the bottom plate, I just think it is easier to see the parts when they are laying on the workbench.  Connect the parts as you see below:
 

diff --git a/docs/guide/create_application.md b/docs/guide/create_application.md
@@ -34,7 +34,7 @@ becomes:
 STEERING_LEFT_PWM = 500
 ```
 
-when edited. You will adjust these later in the [calibrate](/guide/calibrate/) section.
+when edited. You will adjust these later in the [calibrate](calibrate.md) section.
 
 ### Configure I2C PCA9685
 

diff --git a/docs/guide/get_driving.md b/docs/guide/get_driving.md
@@ -45,7 +45,7 @@ races if you have a pilot that will steer but doesn't control throttle.
 
 -----
 
-If you don't have a joystick then you can skip to next section - [train an autopilot](/guide/train_autopilot/).
+If you don't have a joystick then you can skip to next section - [train an autopilot](train_autopilot.md).
 
 -----
 

diff --git a/docs/guide/install_software.md b/docs/guide/install_software.md
@@ -4,7 +4,7 @@
 * Software:
     * [Step 1: Install Software on Host PC](install_software.md#step-1-install-software-on-host-pc)
     * [Step 2: Install Software on Donkeycar](install_software.md#step-2-install-software-on-donkeycar)
-* [Create Donkeycar Application](/guide/create_application/)
+* [Create Donkeycar Application](create_application.md)
 
 ## Overview
 

diff --git a/docs/guide/robot_sbc/intel_t265.md b/docs/guide/robot_sbc/intel_t265.md
@@ -14,7 +14,7 @@ Using the latest version of Raspian (tested with Raspian Buster) on the RPi, fol
 
 ## Step 1: Setup Donkeycar
 
-Follow the standard instructions [here](https://docs.donkeycar.com/guide/install_software/)
+Follow the standard instructions [here](../install_software.md)
 
 ## Step 3: Run the Donkeycar path follower app
 

diff --git a/docs/guide/robot_sbc/setup_jetson_nano.md b/docs/guide/robot_sbc/setup_jetson_nano.md
@@ -6,7 +6,7 @@
 * [Step 2: Install Dependencies](#step-2-install-dependencies)
 * [Step 3: Setup Virtual Env](#step-3-setup-virtual-env)
 * [Step 4: Install Donkeycar Python Code](#step-4-install-donkeycar-python-code)
-* Then [Create your Donkeycar Application](/guide/create_application/)
+* Then [Create your Donkeycar Application](../create_application.md)
 
 ## Step 1: Flash Operating System
 

diff --git a/docs/guide/robot_sbc/setup_raspberry_pi.md b/docs/guide/robot_sbc/setup_raspberry_pi.md
@@ -15,7 +15,7 @@
 * [Step 11: Install Donkeycar Python Code](#step-11-install-donkeycar-python-code)
 * [Step 12: Install Optional OpenCV](#step-12-install-optional-opencv)
 * [Step 13: Install Optional Donkey Car Console](#step-13-install-donkeycar-console)
-* Then [Create your Donkeycar Application](/guide/create_application/)
+* Then [Create your Donkeycar Application](../create_application.md)
 
 ## Step 1: Flash Operating System
 
@@ -308,4 +308,4 @@ For further information of using the app, check the [instruction here](../mobile
 
 ----
 
-### Next, [create your Donkeycar application](/guide/create_application.html).
+### Next, [create your Donkeycar application](../create_application.md).
diff --git a/docs/guide/virtual_race_league.md b/docs/guide/virtual_race_league.md
@@ -16,7 +16,7 @@ You may build the server from the source project above, but [pre-built binaries]
 
 ## Setup for Donkeycar users
 
-If you are using the donkeycar framework to race, you can use follow the guide to [setup the simulator](/guide/simulator/). If visuals directions help out, checkout the [Windows Sim Setup Screen-Cast on Youtube](https://youtu.be/wqQMmHVT8qw). Use this to practice before the race. When it comes time to race, modify your myconfig.py to have these two changes:
+If you are using the donkeycar framework to race, you can use follow the guide to [setup the simulator](simulator.md). If visuals directions help out, checkout the [Windows Sim Setup Screen-Cast on Youtube](https://youtu.be/wqQMmHVT8qw). Use this to practice before the race. When it comes time to race, modify your myconfig.py to have these two changes:
 
 ```
 DONKEY_SIM_PATH = "remote"

diff --git a/docs/legacy.md b/docs/legacy.md
@@ -17,52 +17,52 @@ I printed parts in black PLA, with .3mm layer height with a .5mm nozzle and no s
 ### Step 2: Clean up parts
 Almost all 3D Printed parts will need clean up.  Re-drill holes, and clean up excess plastic.
 
-![donkey](../assets/build_hardware/2a.png)
+![donkey](assets/build_hardware/2a.png)
 
 In particular, clean up the slots in the side of the roll bar, as shown in the picture below:
 
-![donkey](../assets/build_hardware/2b.png)
+![donkey](assets/build_hardware/2b.png)
 
 ### Step 3: Assemble Top plate and Roll Cage
 
 If you have an Exceed Short Course Truck, Blaze or Desert Monster watch this [video](https://youtu.be/UucnCmCAGTI)
 
 Slide the nut into the slot in the side of the roll cage.  This is not particularly easy.  You may need to clean out the hole again and use a small screwdriver to push the screw in such that it lines up with the hole in the bottom of the roll cage.
 
-![donkey](../assets/build_hardware/3a.png)
+![donkey](assets/build_hardware/3a.png)
 
 Once you have slid the nut in, you can attach the bottom plate.  Once again, this may be tricky.  I use the small screwdriver to push against the nut to keep it from spinning in the slot.  Good news: you should never have to do this again.
 
-![donkey](../assets/build_hardware/3b.png)
+![donkey](assets/build_hardware/3b.png)
 
 ### Step 4: Connect Servo Shield to Raspberry Pi
 
 You could do this after attaching the Raspberry Pi to the bottom plate, I just think it is easier to see the parts when they are laying on the workbench.  Connect the parts as you see below:
 
-![donkey](../assets/build_hardware/4a.png)
+![donkey](assets/build_hardware/4a.png)
 
 For reference, below is the Raspberry Pi Pinout for reference.  You will notice we connect to 3.3v, the two I2C pins (SDA and SCL) and ground:
 
-![donkey](../assets/build_hardware/4b.png)
+![donkey](assets/build_hardware/4b.png)
 
 ### Step 5: Attach Raspberry Pi to 3D Printed bottom plate
 
 Before you start, now is a good time to insert the already flashed SD card and bench test the electronics.  Once that is done, attaching the Raspberry Pi and Servo is as simple as running screws through the board into the screw bosses on the top plate.  The M2.5x12mm screws should be the perfect length to go through the board, the plastic and still have room for a washer.  The “cap” part of the screw should be facing up and the nut should be on the bottom of the top plate.  The ethernet and USB ports should face forward.  This is important as it gives you access to the SD card and makes the camera ribbon cable line up properly.
 
 Attach the USB battery to the underside of the printed bottom plate using cable ties or velcro.
 
-![donkey](../assets/build_hardware/5ab.png)
+![donkey](assets/build_hardware/5ab.png)
 
 ### Step 6: Attach Camera
 
 There are two versions of the donkey chassis, the newer one does not have screws, the older one does. This includes instructions for both:
 
 **Screwless Design**
 The newer design is pretty simple, just slip the camera into the slot, cable end first.  However, be careful not to push on the camera lens and instead press the board.
-![donkey](../assets/build_hardware/assemble_camera.jpg)
+![donkey](assets/build_hardware/assemble_camera.jpg)
 
 If you need to remove the camera the temptation is to push on the lens, instead push on the connector as is shown in these pictures.  
-![donkey](../assets/build_hardware/Remove--good.jpg) ![donkey](../assets/build_hardware/Remove--bad.jpg)
+![donkey](assets/build_hardware/Remove--good.jpg) ![donkey](assets/build_hardware/Remove--bad.jpg)
 
 **Design with Screws**
 
@@ -72,36 +72,36 @@ Attaching the camera is a little tricky, the M2 screws can be screwed into the p
 
 Before using the car, remove the plastic film from the camera lens.
 
-![donkey](../assets/build_hardware/6a.png)
+![donkey](assets/build_hardware/6a.png)
 
 It is easy to put the camera cable in the wrong way so look at these photos and make sure the cable is put in properly.  There are loads of tutorials on youtube if you are not used to this.
 
-![donkey](../assets/build_hardware/6b.png)
+![donkey](assets/build_hardware/6b.png)
 
 ### Step 7: Put it all together
 
 *** Note if you have a Desert Monster Chassis see 7B section below ***
 
 The final steps are straightforward.  First attach the roll bar assembly to the car.  This is done using the same pins that came with the vehicle.  
 
-![donkey](../assets/build_hardware/7a.png)
+![donkey](assets/build_hardware/7a.png)
 
 Second run the servo cables up to the car.  The throttle cable runs to channel 0 on the servo controller and steering is channel 1.
 
-![donkey](../assets/build_hardware/7b.png)
+![donkey](assets/build_hardware/7b.png)
 
 Now you are done with the hardware!!
 
 ### Step 7b: Attach Adapters (Desert Monster only)
 
 The Desert monster does not have the same set up for holding the body on the car and needs two adapters mentioned above.  To attach the adapters you must first remove the existing adapter from the chassis and screw on the custom adapter with the same screws as is shown in this photo:
 
-![adapter](../assets/build_hardware/Desert_Monster_adapter.png)
+![adapter](assets/build_hardware/Desert_Monster_adapter.png)
 
 Once this is done, go back to step 7
 
 ## Software
 
 Congrats!  Now to get your get your car moving, see the [software instructions](guide/install_software.md) section.
 
-![donkey](../assets/build_hardware/donkey2.png)
+![donkey](assets/build_hardware/donkey2.png)
diff --git a/docs/parts/actuators.md b/docs/parts/actuators.md
@@ -4,11 +4,11 @@ You have several options to control your car's servo and motors, ranging from di
 
 ## Control with an I2C servo driver board. 
 
-This is described in the overall setup instructions [here](https://docs.donkeycar.com/guide/build_hardware/)
+This is described in the overall setup instructions [here](../guide/build_hardware.md)
 
 ## Direct control with the RaspberryPi GPIO pins. 
 
-Please follow the instructions [here](https://docs.donkeycar.com/parts/rc/)
+Please follow the instructions [here](rc.md)
 
 ## Control with the Robo HAT MM1 board. 
 

diff --git a/docs/parts/keras.md b/docs/parts/keras.md
@@ -1,6 +1,6 @@
 # Keras Parts
 
-These parts encapsulate models defined using the [Keras](https://keras.io/) high level api. They are intended to be used with the Tensorflow backend. The parts are designed to use the trained artificial neural network to reproduce the steering and throttle given the image the camera sees. They are created by using the [train command](/guide/train_autopilot/).
+These parts encapsulate models defined using the [Keras](https://keras.io/) high level api. They are intended to be used with the Tensorflow backend. The parts are designed to use the trained artificial neural network to reproduce the steering and throttle given the image the camera sees. They are created by using the [train command](../guide/train_autopilot.md).
 
 ## Keras Categorical
 

diff --git a/docs/parts/path_following.md b/docs/parts/path_following.md
@@ -18,7 +18,7 @@ Using the latest version of Raspian (tested with Raspian Buster) on the RPi, fol
 
 ## Step 2: Setup Donkeycar
 
-Follow the standard instructions [here](https://docs.donkeycar.com/guide/install_software/). With the Path Follower, there is no need to install Tensorflow for this particular Donkeycar configuration however do install numpy/upgrade before running "pip install -e .[pi]"
+Follow the standard instructions [here](../guide/install_software.md). With the Path Follower, there is no need to install Tensorflow for this particular Donkeycar configuration however do install numpy/upgrade before running "pip install -e .[pi]"
 
 ## Step 3: Create the Donkeycar path follower app
 

diff --git a/docs/supported_cars.md b/docs/supported_cars.md
@@ -39,9 +39,7 @@ Visual instructions to follow.
 
 ## LaTrax Prerunner
 
-The LaTrax prerunner is a supported car and follows the same build instructions as the Desert Monster.  However the adapters get screwed in as is shown in the photo below.  
-
-![donkey](./assets/Latrax.jpg)
+The LaTrax prerunner is a supported car and follows the same build instructions as the Desert Monster.  However the adapters get screwed in as is shown in the photo below.
 
 ## Donkey Pro
 
@@ -105,4 +103,4 @@ available options that will work, so you should not expect to choose other optio
 save money. Rolling your own is more about learning, experimentation, and going to new
 and uncharged places.
 
-To find out more about what you need, see [Roll Your Own](/roll_your_own/).
+To find out more about what you need, see [Roll Your Own](roll_your_own.md).
diff --git a/docs/utility/donkey.md b/docs/utility/donkey.md
@@ -38,7 +38,7 @@ sudo apt install nmap
 ## Calibrate Car
 
 This command allows you to manually enter values to interactively set the PWM values and experiment with how your robot responds.
-See also [more information.](/guide/calibrate/)
+See also [more information.](../guide/calibrate.md)
 
 Usage:
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,13 +2,17 @@
 site_name: Donkey Car
 theme: readthedocs
 
+# To enable strict check you need to comment google_analytics, otherwise it will generate a warning
+# @see https://github.com/autorope/donkeydocs/issues/21
+# strict: true # Check all absolute link, prevent broken links
+
 repo_url: https://github.com/autorope/donkeydocs/
 edit_uri: edit/master/docs
 google_analytics: ['UA-99215530-2', 'github.io/donkey']
 extra_css:
   - extra.css
 
-pages:
+nav:
   - Home: index.md
   - User Guide:
       - 'Build a car.': guide/build_hardware.md