m-labs / artiq

A leading-edge control system for quantum information experiments
https://m-labs.hk/artiq
GNU Lesser General Public License v3.0
426 stars 197 forks source link

doc: Edit of manual reference pages #2466

Closed architeuthidae closed 2 months ago

architeuthidae commented 3 months ago

ARTIQ Pull Request

Added missing frontend methods to Utilities (creating get_argparser when necessary). Refactored detailed explanation of artiq_coremgmt out of reference to keep it clean and into Core device (cut down some). Added (complete?) list of currently used config keys. Formatting fixes in reference pages and somewhat tangentially in Installing (not strictly related except that the config key list is pretty heavily interreferenced with it.)

Added AFWS password restrictions as referenced from support instructions

Description of Changes

Related Issue

Closes #1025

Type of Changes

Type
:scroll: Docs

Steps (Choose relevant, delete irrelevant before submitting)

All Pull Requests

Documentation Changes

Git Logistics

Licensing

See copyright & licensing for more info. ARTIQ files that do not contain a license header are copyrighted by M-Labs Limited and are licensed under LGPLv3+.

architeuthidae commented 3 months ago

rebased for merge conflict

architeuthidae commented 2 months ago

Re: last commit -- source order seems like a better choice; it e.g. groups all the decorators and all the argument types together, whereas alphabetical has them spread out in an unintuitive way. In theory it's nice to be able to find things alphabetically too but these references aren't that long and in practice I'm sure anybody would be using ctrl+F.

architeuthidae commented 2 months ago

Rebased (removed the formatting corrections to Installing, which were tangential anyway) to avoid a merge conflict with a future PR + cleanup commit history while I'm at it