M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq
2
0
Fork 1
Code Issues Projects Releases Wiki Activity

fix documentation formatting problems

pull/668/merge
Sebastien Bourdeauducq 2017-05-22 19:05:39 +08:00
parent e4a631a3d7
commit cf746cee5b
3 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
RELEASE_NOTES.rst
View File

@ -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.

2
doc/manual/default_network_ports.rst
View File

@ -15,7 +15,7 @@ Default network ports
| Master (logging input) | 1066 |
+--------------------------------+--------------+
| Master (broadcasts) | 1067 |
+--------------------------------+--------------|
+--------------------------------+--------------+
| Core device logging controller | 1068 |
+--------------------------------+--------------+
| InfluxDB bridge | 3248 |

1
doc/manual/developing.rst
View File

@ -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 <install-anaconda>`
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::