Merge branch 'master' of github.com:scylladb/sphinx-scylladb-theme

Author: dgarcia360

.github/workflows/[email protected]

@@ -1,14 +1,15 @@
-name: "Publish docs to GitHub Pages"
+name: "Docs / Publish"
 
 on:
   push:
     branches:
       - master
     paths:
       - "docs/**"
+  workflow_dispatch:
+
 jobs:
   release:
-    name: Build
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -21,11 +22,8 @@ jobs:
         with:
           python-version: 3.7
       - name: Build docs
-        run: |
-          export PATH=$PATH:~/.local/bin
-          cd docs
-          make multiversion
-      - name: Deploy
+        run: make -C docs multiversion
+      - name: Deploy docs to GitHub Pages
         run: ./docs/_utils/deploy.sh
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/[email protected]

@@ -1,4 +1,4 @@
-name: "Build docs on pull requests"
+name: "Docs / Build PR"
 
 on:
   pull_request:
@@ -8,8 +8,7 @@ on:
       - "docs/**"
 
 jobs:
-  release:
-    name: Build
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -22,7 +21,4 @@ jobs:
         with:
           python-version: 3.7
       - name: Build docs
-        run: |
-          export PATH=$PATH:~/.local/bin
-          cd docs
-          make test
+        run: make -C docs test

docs/source/commands.rst

@@ -2,7 +2,14 @@
 Commands
 ========
 
-To run the next commands you will need to have installed Python 3.7 and PIP.
+Use the command-line interface to run the following commands.
+
+Prerequisites
+-------------
+
+To run the following commands, you will need to have installed **Python +3.7** and **PIP** on your local environment.
+
+If you are on **Windows**, you will need to run them from a Unix-based terminal such as `Git Bash <https://www.atlassian.com/git/tutorials/git-bash>`_.
 
 Preview current branch
 ----------------------
@@ -89,4 +96,4 @@ Check for broken links on the documentation site.
 
     cd docs
     make dirhtml
-    make linkcheck
+    make linkcheck

docs/source/getting-started/installation.rst

@@ -2,7 +2,14 @@
 Installation
 ============
 
-This quickstart walks you through the steps required to add the documentation toolchain to a project hosted on GitHub.
+This quickstart walks you through the steps required to add the documentation toolchain to a ScyllaDB project hosted on GitHub.
+
+Prerequisites
+-------------
+
+Before adding the documentation toolchain to a project, you will need to have installed **Python +3.7** and **PIP** on your local environment.
+
+If you are on **Windows**, you will need to run ``make`` commands from a Unix-based terminal such as `Git Bash <https://www.atlassian.com/git/tutorials/git-bash>`_.
 
 Step 1: Download the sample project
 -----------------------------------
@@ -12,26 +19,26 @@ Step 1: Download the sample project
    .. code:: console
 
       project-name/
-         ├── pyproject.toml
-         ├── .github/workflows/[email protected]
-         ├── .github/workflows/[email protected]
+         ├── .github/
+         |   ├── workflows/
+         |   |   ├── [email protected]
+         |   |   ├── [email protected]
          ├── docs/
          │   ├── _utils/
+         │   |   ├── redirections.yaml
          │   |   ├── deploy.sh
-         │   |   ├── redirect.sh
          │   |   ├── setup.sh
          │   ├── source/
          │   ├── Makefile
 
-   .. note:: If you already have docs in the project under an existing ``docs`` directory, move the doc files to the ``docs/source`` directory.
+   .. note:: If you already have docs in the project under an existing ``docs`` directory, move the doc files to ``docs/source`` directory.
 
 #. Create the file ``docs/pyproject.toml`` under the new ``docs`` folder. Copy the contents from the `pyproject.toml template <docs/_utils/pyproject_template.toml>`_.
 
-
 Step 2: Configure the theme
 ---------------------------
 
-#. Edit the file ``docs/source/conf.py`` file to suit the project needs (e.g. install new extensions, edit navigation links, ...).
+#. Edit the file ``docs/source/conf.py`` file to suit the project needs (e.g., edit the project name and site description, install new extensions, ...).
    For more information, see :doc:`Configuration <../configuration/index>`.
 
 #. If you don't already have a ``.gitignore`` file in the project, place one in the root directory and include ``/docs/_build`` and ``/source/.doctrees`` in it.

sphinx_scylladb_theme/static/css/main.css

@@ -29,7 +29,6 @@
   }
 
   &__img {
-    opacity: 0.3;
     position: absolute;
     right: -18px;
     top: 20px;