From 362027170d9876b7693f6d9971a9e3f1325ace96 Mon Sep 17 00:00:00 2001 From: Kareem Farid Date: Mon, 15 Jan 2024 21:03:32 +0200 Subject: [PATCH] fix headings in installation docs --- docs/source/getting_started/common/_ubuntu_packages.md | 2 +- .../getting_started/common/docker_installation/_common.md | 4 ++-- .../common/docker_installation/installation_linux.md | 2 +- .../common/docker_installation/installation_ubuntu.md | 3 ++- .../common/nix_installation/installation_win.md | 1 + docs/source/getting_started/common/wsl/_wsl.md | 1 + 6 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/source/getting_started/common/_ubuntu_packages.md b/docs/source/getting_started/common/_ubuntu_packages.md index cf03bf2a1..64ec83af7 100644 --- a/docs/source/getting_started/common/_ubuntu_packages.md +++ b/docs/source/getting_started/common/_ubuntu_packages.md @@ -1,4 +1,4 @@ -

Installation of required packages

+# 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 index 14ecfd889..d035740f2 100644 --- 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 index 4001224fa..fcfb07c07 100644 --- 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 index 65b91aa12..b3f1abe7e 100644 --- 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 ``` -

Installing Docker

+## 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 index 37e318eaf..200f110e3 100644 --- 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 index 8a4bcbcf7..e6f187af4 100644 --- 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 ```