Skip to content

Commit

Permalink
Add info about building older versions of documentation to README (#129)
Browse files Browse the repository at this point in the history
* add info about building older versions of documentation

* improve documentation

* Update README.rst

Co-authored-by: Ville Bergholm <[email protected]>

---------

Co-authored-by: Ville Bergholm <[email protected]>
  • Loading branch information
freetonik and smite authored Apr 11, 2024
1 parent 40c4298 commit fa6fb1e
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,20 @@ for a quick introduction on how to use Cirq on IQM.

Take a look at the `Jupyter notebook <https://jupyter.org/>`_ 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 [email protected]: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
=========
Expand Down

0 comments on commit fa6fb1e

Please sign in to comment.