Skip to content

Commit

Permalink
feat(docs): instructions on using nvme-spex with docker
Browse files Browse the repository at this point in the history
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 <m.rasmussen@samsung.com>
  • Loading branch information
mbrsamsung committed Sep 26, 2024
1 parent 3b3c3af commit db01c27
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,24 @@ 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
<https://docs.docker.com/desktop/install/windows-install/>`_ or `Podman
<https://podman.io/docs/installation>`_

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
<https://docs.docker.com/desktop/install/windows-install/>`_.

.. 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 <http://localhost:8000>`_.
Expand Down

0 comments on commit db01c27

Please sign in to comment.