From cf746cee5b796416ec454ca5bfeebbd22a7915f9 Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Mon, 22 May 2017 19:05:39 +0800 Subject: [PATCH] fix documentation formatting problems --- RELEASE_NOTES.rst | 8 ++++---- doc/manual/default_network_ports.rst | 2 +- doc/manual/developing.rst | 1 + 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst index e01267e35..d3c4f2aaf 100644 --- a/RELEASE_NOTES.rst +++ b/RELEASE_NOTES.rst @@ -7,10 +7,10 @@ Release notes ---------------- * The --embed option of applets is replaced with the environment variable - ARTIQ_APPLET_EMBED. The GUI sets this enviroment variable itself and the - user simply needs to remove the --embed argument. + ``ARTIQ_APPLET_EMBED``. The GUI sets this enviroment variable itself and the + user simply needs to remove the ``--embed`` argument. * EnvExperiment's prepare calls prepare for all its children. -* Dynamic __getattr__'s returning RPC target methods are not supported anymore. +* Dynamic ``__getattr__``'s returning RPC target methods are not supported anymore. Controller driver classes must define all their methods intended for RPC as members. * Datasets requested by experiments are by default archived into their HDF5 @@ -34,7 +34,7 @@ Release notes * The device database is now generated by an executable Python script. To migrate an existing database, add ``device_db = `` at the beginning, and replace any PYON identifiers (``true``, ``null``, ...) with their Python equivalents - (``True``, ``None` ...). + (``True``, ``None`` ...). * Controllers are now named ``aqctl_XXX`` instead of ``XXX_controller``. * In the device database, the "comm" device has been folded into the "core" device. Move the "host" argument into the "core" device, and remove the "comm" device. diff --git a/doc/manual/default_network_ports.rst b/doc/manual/default_network_ports.rst index 188270095..a1d83dd07 100644 --- a/doc/manual/default_network_ports.rst +++ b/doc/manual/default_network_ports.rst @@ -15,7 +15,7 @@ Default network ports | Master (logging input) | 1066 | +--------------------------------+--------------+ | Master (broadcasts) | 1067 | -+--------------------------------+--------------| ++--------------------------------+--------------+ | Core device logging controller | 1068 | +--------------------------------+--------------+ | InfluxDB bridge | 3248 | diff --git a/doc/manual/developing.rst b/doc/manual/developing.rst index b495fd31e..22d807358 100644 --- a/doc/manual/developing.rst +++ b/doc/manual/developing.rst @@ -24,6 +24,7 @@ ARTIQ Anaconda development environment $ git clone --recursive https://github.com/m-labs/artiq ~/artiq-dev/artiq $ cd ~/artiq-dev/artiq + Add ``-b release-X`` to the ``git clone`` command if you are building a stable branch of ARTIQ (the default will fetch the development ``master`` branch). 3. :ref:`Install Anaconda or Miniconda ` 4. Create and activate a conda environment named ``artiq-dev`` and install the ``artiq-dev`` package which pulls in all the packages required to develop ARTIQ::