doc: Edit of manual reference pages #2466
Conversation
architeuthidae
force-pushed
the
man-reference-update
branch
from
9df4cfe
to
0100189
Compare
architeuthidae
force-pushed
the
man-reference-update
branch
from
0100189
to
1b9ae62
Compare
architeuthidae
force-pushed
the
man-reference-update
branch
from
ac78e31
to
47e1371
Compare
|
rebased for merge conflict |
artiq/frontend/afws_client.py
Outdated
|
|
||
|
|
||
| async def main_async(): | ||
| args = get_argparser().parse_args() |
There was a problem hiding this comment.
Those AFWS coding style changes should not be in this PR, especially since they cause problems with the release-8 backport where afws_client does not use asyncio.
There was a problem hiding this comment.
Minimized changes as much as possible but it's still necessary to create a get_argparser to render documentation in the manual, so the backport may still be inconvenient...? Not entirely sure what best to do about that
There was a problem hiding this comment.
Agreed that these changes in afws_client should not be included in this PR for backporting purposes. I can create a separate PR for get_argparser for both the beta and stable branches.
There was a problem hiding this comment.
Okay, reset afws_client entirely; Sphinx raises a warning about a missing argparser but it does still compile the page. Thanks and sorry for the trouble!
There was a problem hiding this comment.
Already submitted a PR for stable: #2488 and beta on afws (Gitea). Hopefully, those warnings will be gone once they are merged.
doc/manual/installing.rst
Outdated
|
|
||
| * For Kasli or KC705: | ||
|
|
||
| If the ``ip`` config field is not set or set to ``use_dhcp``, the device will attempt to obtain an IP address and default gateway using DHCP. If a static IP address is nonetheless wanted, it can be flashed directly (OpenOCD must be installed and configured, as above), along with, as necessary, default gateway, IPv6, and/or MAC address: :: | ||
| If the ``ip`` config field is not set or set to ``use_dhcp``, the device will attempt to obtain an IP address and default gateway using DHCP. If a static IP address is nonetheless wanted, it can be flashed directly (OpenOCD must be installed and configured, as above), along with, as necessary, default gateway, IPv6, and/or MAC address: :: |
There was a problem hiding this comment.
artiq-zynq doesn't use a default gateway, but I think you don't have to clarify that here...
architeuthidae
force-pushed
the
man-reference-update
branch
from
3359040
to
6105889
Compare
architeuthidae
force-pushed
the
man-reference-update
branch
from
6105889
to
8974d14
Compare
|
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
force-pushed
the
man-reference-update
branch
from
0778cc0
to
18759a0
Compare
|
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 |
|
|
||
| To use this tool, it is necessary to specify the IP address your core device can be contacted at. If no option is used, the utility will assume there is a file named ``device_db.py`` in the current directory containing the device database; otherwise, a device database file can be provided with ``--device-db`` or an address directly with ``--device`` (see also below). | ||
|
|
||
| To read core device logs:: | ||
|
|
||
| $ artiq_coremgmt log |
There was a problem hiding this comment.
At least this one is quite useful and should not be removed from the examples.
There was a problem hiding this comment.
The command is already mentioned in both 'Installing' and 'RTIO', and the same information is provided by the auto-generated documentation a few lines below this. (Separately, it might be nice to have a dedicated section on the various logs and their management in 'Core device', which could go into more depth, but that'd be a different PR). If we prefer I can add it back, but none of the other utilities commands have their examples or guides on the reference page, so it seems a little out of place.
Co-authored-by: architeuthis <[email protected]>
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
Steps (Choose relevant, delete irrelevant before submitting)
All Pull Requests
Documentation Changes
cd doc/manual/; make html) to ensure no errors.Git Logistics
git rebase --interactive). Merge/squash/fixup commits that just fix or amend previous commits. Remove unintended changes & cleanup. See tutorial.git show). Format: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+.