From fa6fb1eb392a85e304458e26f0040e91d20018b2 Mon Sep 17 00:00:00 2001 From: Rakhim Davletkaliyev Date: Thu, 11 Apr 2024 11:04:55 +0300 Subject: [PATCH] Add info about building older versions of documentation to README (#129) * add info about building older versions of documentation * improve documentation * Update README.rst Co-authored-by: Ville Bergholm <1044345+smite@users.noreply.github.com> --------- Co-authored-by: Ville Bergholm <1044345+smite@users.noreply.github.com> --- README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.rst b/README.rst index 28866805..0179f498 100644 --- a/README.rst +++ b/README.rst @@ -45,6 +45,20 @@ for a quick introduction on how to use Cirq on IQM. Take a look at the `Jupyter notebook `_ with examples: ``examples/usage.ipynb``. +You can build documentation for any older version locally by cloning the Git repository, checking out the +corresponding tag, and running the docs builder. For example, to build the documentation for version ``12.2``: + +.. code-block:: bash + + $ git clone git@github.com:iqm-finland/cirq-on-iqm.git + $ cd cirq-on-iqm + $ git checkout 12.2 + $ tox run -e docs + +``tox run -e docs`` will build the documentation at ``./build/sphinx/html``. This command requires the ``tox,``, ``sphinx`` and +``sphinx-book-theme`` Python packages (see the ``docs`` optional dependency in :file:`pyproject.toml`); +you can install the necessary packages with ``pip install -e ".[dev,docs]"`` + Copyright =========