From b85aabafe04145de97840aa28c67317d8478b148 Mon Sep 17 00:00:00 2001 From: "Morten B. Rasmussen" Date: Mon, 23 Sep 2024 13:33:42 +0200 Subject: [PATCH] feat(docs): instructions on using nvme-spex with docker Adds instructions to the sphinx documentation, that describes how it is possible to use nvme-spex directly through docker. Without starting the webserver. Signed-off-by: Morten B. Rasmussen --- docs/source/index.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 0449d16..1bbf7d7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -20,15 +20,25 @@ on data-structures in the NVMe specification documents. To read more about what **Spex** does, see :ref:`sec-what-is-spex`. For help on setting up **Spex** on your system, see :ref:`sec-setup`. -For direct usage of nvme-spex as a linting tool it is possible to run it from -docker. For setup of docker on windows we refer to guides from `Docker Desktop + +For direct usage of nvme-spex it is possible to run it from docker. For setup of +docker on windows we refer to guides from `Docker Desktop `_ or `Podman `_ +.. code-block:: shell + + docker run --rm -v ~/Documents/specs/:/specs ghcr.io/samsungds/nvme-spex-webserver:latest run -s --output=/specs/output /specs/nvme_base.docx + +The output of the run will be available at ~/Documents/specs/output in this example. + +It is also possible to lint the docx specification by using the web application. +To start the web application can be started with the following command: + .. code-block:: shell docker pull ghcr.io/samsungds/nvme-spex-webserver:latest - docker run -p 8000:8000 ghcr.io/samsungds/nvme-spex-webserver:latest + docker run --rm -p 8000:8000 ghcr.io/samsungds/nvme-spex-webserver:latest webserver When the docker container is successfully running the web application can be accessed in the browser at `http://localhost:8000 `_.