fix headings in installation docs

efabless · Jan 15, 2024 · 3620271 · 3620271
1 parent 8bb4119
commit 3620271
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 5 deletions.
diff --git a/docs/source/getting_started/common/_ubuntu_packages.md b/docs/source/getting_started/common/_ubuntu_packages.md
@@ -1,4 +1,4 @@
-<h2> Installation of required packages </h2>
+# Installation of required packages
 
 Update the package database and upgrade the packages to avoid version mismatches then install required packages as follows:
 

diff --git a/docs/source/getting_started/common/docker_installation/_common.md b/docs/source/getting_started/common/docker_installation/_common.md
@@ -44,7 +44,7 @@ See 'docker run --help'.
 OpenLane>
 ```
 
-## Checking Installation Requirements
+# Checking Installation Requirements
 
 In order to check the installation, you can use the following commands:
 
@@ -68,7 +68,7 @@ Once an environment has been created, you may wish to activate it, e.g. by
 sourcing an activate script in its bin directory.
 ```
 
-## Download and Install OpenLane
+# Download and Install OpenLane
 
 - Download OpenLane using PIP:
 

diff --git a/docs/source/getting_started/common/docker_installation/installation_linux.md b/docs/source/getting_started/common/docker_installation/installation_linux.md
@@ -44,7 +44,7 @@ https://docs.docker.com/get-started/
 ```
 
 ```{include} docker_no_root.md
-:heading-offset: 1
+:heading-offset: 2
 
 ```
 

diff --git a/docs/source/getting_started/common/docker_installation/installation_ubuntu.md b/docs/source/getting_started/common/docker_installation/installation_ubuntu.md
@@ -3,10 +3,11 @@
 Only Ubuntu 20.04 and above are supported.
 
 ```{include} ../_ubuntu_packages.md
+:heading-offset: 1
 
 ```
 
-<h3> Installing Docker </h3>
+## Installing Docker
 
 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.

diff --git a/docs/source/getting_started/common/nix_installation/installation_win.md b/docs/source/getting_started/common/nix_installation/installation_win.md
@@ -2,6 +2,7 @@
 
 ```{include} ../wsl/_wsl.md
 :relative-images:
+:heading-offset: 1
 ```
 
 ## Installing Nix

diff --git a/docs/source/getting_started/common/wsl/_wsl.md b/docs/source/getting_started/common/wsl/_wsl.md
@@ -58,5 +58,6 @@ https://docs.docker.com/go/wsl2/
 9. Follow the steps shown below.
 
 ```{include} ../_ubuntu_packages.md
+:heading-offset: 1
 
 ```
-Original file line number
+Diff line change
@@ Expand Up / @@ -44,7 +44,7 @@ https://docs.docker.com/get-started/ @@
     ```
     ```{include} docker_no_root.md
-    :heading-offset: 1
+    :heading-offset: 2
     ```
@@ Expand Down @@