fix even more warnings generated by myst

docs/source/getting_started/common/_ubuntu_packages.md.part → docs/source/getting_started/common/_ubuntu_packages.md

@@ -1,4 +1,4 @@
-# Installation of required packages
+<h2> Installation of required packages </h2>
 
 Update the package database and upgrade the packages to avoid version mismatches then install required packages as follows:
 

docs/source/getting_started/common/docker_installation/_common.md.part → docs/source/getting_started/common/docker_installation/_common.md

@@ -1,4 +1,4 @@
-## Checking the Docker Installation
+# Checking the Docker Installation
 
 After that, you can run Docker Hello World without root. To test it use the following command:
 
@@ -35,7 +35,7 @@ https://docs.docker.com/get-started/
 ## Troubleshooting Docker permission issues (Linux only)
 
 If you get Docker permission error when running any Docker images, then likely,
-you forgot to follow the steps to make Docker available without root or you need to *restart your Operating System*.
+you forgot to follow the steps to make Docker available without root or you need to _restart your Operating System_.
 
 ```
 OpenLane> docker run hello-world
@@ -70,13 +70,13 @@ sourcing an activate script in its bin directory.
 
 ## Download and Install OpenLane
 
-* Download OpenLane using PIP:
+- Download OpenLane using PIP:
 
 ```sh
 python3 -m pip install openlane
 ```
 
-* Run a smoke test for OpenLane:
+- Run a smoke test for OpenLane:
 
 ```sh
 python3 -m openlane --dockerized --smoke-test

docs/source/getting_started/common/docker_installation/docker_no_root.md.part → docs/source/getting_started/common/docker_installation/docker_no_root.md

@@ -1,4 +1,4 @@
-## Making Docker available without root (Linux only)
+# Making Docker available without root (Linux only)
 
 :::{warning}
 The steps below might become outdated. It is recommended to follow the link to the official Docker documentation here: [instructions here](https://docs.docker.com/engine/install/linux-postinstall/).

docs/source/getting_started/common/docker_installation/installation_linux.md

@@ -43,10 +43,12 @@ For more examples and ideas, visit:
 https://docs.docker.com/get-started/
 ```
 
-```{include} docker_no_root.md.part
+```{include} docker_no_root.md
+:heading-offset: 1
 
 ```
 
-```{include} _common.md.part
+```{include} _common.md
+:heading-offset: 1
 
 ```

docs/source/getting_started/common/docker_installation/installation_macos.md

@@ -13,14 +13,15 @@ brew install --cask docker
 
 Under **Preferences** > **Resources** > **File Sharing**, make sure `/Users` is mounted as follows, as using OpenLane 2+ with Docker requires access to your home folder.
 
-:::{figure} ../../../../_static/installation/mac_docker_settings.png
+:::{figure} ../../../../\_static/installation/mac_docker_settings.png
 :::
 
 It may also be prudent to enable Full Disk Access permissions for Docker: Under **System Settings** > **Privacy** > **Full Disk Access**, tick Docker as shown:
 
-:::{figure} ../../../../_static/installation/mac_docker_privacy.png
+:::{figure} ../../../../\_static/installation/mac_docker_privacy.png
 :::
 
-```{include} _common.md.part
+```{include} _common.md
+:heading-offset: 1
 
 ```

docs/source/getting_started/common/docker_installation/installation_ubuntu.md

@@ -2,11 +2,11 @@
 
 Only Ubuntu 20.04 and above are supported.
 
-```{include} ../_ubuntu_packages.md.part
+```{include} ../_ubuntu_packages.md
 
 ```
 
-### Installing Docker
+<h3> Installing Docker </h3>
 
 Next, install Docker.
 Follow [the instructions provided in the Docker documentation here](https://docs.docker.com/engine/install/ubuntu/) as the steps provided below might be outdated.
@@ -64,10 +64,12 @@ For more examples and ideas, visit:
 https://docs.docker.com/get-started/
 ```
 
-```{include} docker_no_root.md.part
+```{include} docker_no_root.md
+:heading-offset: 1
 
 ```
 
-```{include} _common.md.part
+```{include} _common.md
+:heading-offset: 1
 
 ```

docs/source/getting_started/common/docker_installation/installation_win.md

@@ -1,7 +1,11 @@
 # Windows 10+
+
 ```{include} ../wsl/_wsl.md
 :relative-images:
+:heading-offset: 1
 ```
 
-```{include} _common.md.part
+```{include} _common.md
+:heading-offset: 1
+
 ```

docs/source/getting_started/common/nix_installation/_common.md.part → docs/source/getting_started/common/nix_installation/_common.md

@@ -1,4 +1,5 @@
-### Setting up the binary cache
+# Setting up the binary cache
+
 Cachix allows the reproducible Nix builds to be stored on a cloud server so you do not have to build OpenLane's dependencies from scratch on every computer, which will take a long time.
 
 First, you want to install Cachix by running the following in your terminal:
@@ -13,16 +14,17 @@ Then set up the OpenLane binary cache as follows:
 cachix use openlane
 ```
 
-``````{note}
+````{note}
 If `cachix use openlane` fails, re-run it as follows:
 
 ```sh
 sudo env PATH="$PATH" cachix use openlane
 ```
 
-``````
+````
+
+# Cloning OpenLane
 
-### Cloning OpenLane
 With git installed, just run the following:
 
 ```sh

docs/source/getting_started/common/nix_installation/installation_linux.md

@@ -5,6 +5,7 @@ We will primarily support Ubuntu 20.04+ for OpenLane.
 If you're looking to build a virtual machine, we recommend [Ubuntu 22.04](https://releases.ubuntu.com/jammy/).
 
 ## Installing Nix
+
 You can install Nix by following the instructions at https://nixos.org/download.html.
 
 For example, on Ubuntu, run the following your terminal.
@@ -24,5 +25,6 @@ Enter your password if prompted. This should take around 5 minutes.
 
 Make sure to close all terminals after you're done with this step.
 
-```{include} _common.md.part
+```{include} _common.md
+:heading-offset: 1
 ```

docs/source/getting_started/common/nix_installation/installation_macos.md

@@ -1,6 +1,7 @@
 # macOS 11+
 
 ## Installing Nix
+
 You can install Nix by following the instructions at https://nixos.org/download.html.
 
 You may be able to just run this in your terminal:
@@ -13,5 +14,7 @@ Enter your password if prompted. This should take around 5 minutes.
 
 Make sure to close all terminals after you're done with this step.
 
-```{include} _common.md.part
+```{include} _common.md
+:heading-offset: 1
+
 ```

docs/source/getting_started/common/nix_installation/installation_win.md

@@ -5,6 +5,7 @@
 ```
 
 ## Installing Nix
+
 You can install Nix by following the instructions at https://nixos.org/download.html.
 
 ```sh
@@ -18,4 +19,5 @@ Make sure to close the Ubuntu terminal after you're done with this step and
 start it again.
 
 ```{include} _common.md.part
+:heading-offset: 1
 ```

docs/source/getting_started/common/wsl/_wsl.md

@@ -2,7 +2,7 @@ A recent version of Windows 10 or Windows 11 is required, for more information c
 
 The following is the recommended installation method under Windows. Other virtualization-based methods, such as VMWare, are not supported, and some such as VirtualBox are known to impair the operation of OpenLane.
 
-## Setting up WSL
+# Setting up WSL
 
 1. Follow [official Microsoft documentation for WSL located here](https://docs.microsoft.com/en-us/windows/wsl/install) to install the WSL 2. Make sure your OS version supports WSL 2.
 2. Follow [official steps to Install Docker Desktop on Windows located here](https://docs.docker.com/desktop/install/windows-install/).
@@ -53,10 +53,10 @@ https://docs.docker.com/go/wsl2/
 
 8. Launch "Ubuntu" from your Start Menu.
 
-
 ![](./wsl.png)
 
 9. Follow the steps shown below.
 
-```{include} ../_ubuntu_packages.md.part
+```{include} ../_ubuntu_packages.md
+
 ```