summaryrefslogtreecommitdiff
path: root/maint/rpc-docs-tool
Commit message (Collapse)AuthorAgeFilesLines
* rpc-docs-tool: Fix documentation for methods that apply to all objectsNick Mathewson2025-01-231-7/+30
| | | | | | | This is not yet strictly automated yet, but since there is only one such method this is probably good enough for now. Closes #1708.
* rpc-doc-tool: Fix dangling RustDoc linksNick Mathewson2025-01-231-11/+47
| | | | | | | | | | | | | | | | We already successfully handled links of the forms: * `[RustId]` * `[text](https://...)` * `[text][label]` But we didn't handle links of the form: * `[text](RustId)` These latter links aren't correct markdown on their own; but they're simple enough to fix up after a little hacking on the marko backend representation.
* rpc-docs-tool: Emit methods and objects in sorted order.Nick Mathewson2025-01-231-4/+7
|
* rpc-docs-tool: Update version recommendationNick Mathewson2025-01-231-2/+2
| | | | (Current nightly works fine, so we can stop recommending a downgrade.)
* rpc-docs-tool: Use new connect-point API to connect to arti.Nick Mathewson2025-01-231-4/+1
| | | | Fortunately, the new API has simplified matters greatly!
* fix: fix typosDimitris Apostolou2025-01-061-2/+2
|
* python: one import per line.Nick Mathewson2024-10-241-1/+2
|
* Python: use a more lint-acceptable block comment format.Nick Mathewson2024-10-241-3/+6
|
* rpc-docs-tool: imports go at the head of the module.Nick Mathewson2024-10-241-7/+7
|
* Run "black" to reformat all our pythonNick Mathewson2024-10-241-5/+12
| | | | | | | | | | | | | | | | | "Black" is an "opinionated" python formatter, whose opinionatedness is somewhat in the spirit of rustfmt. This MR runs black with default settings on all of our python code in Arti. It was produced by the following commands ``` # Everything in python/ black python/ # Everything with a .py extension fd '.py$' -X black # Everything with a python shebang. git grep -l '#! */usr/bin/env *python' | xargs black ```
* rpc-docs-tool: Provide better warning on rustdoc format mismatch.Nick Mathewson2024-10-231-0/+27
|
* Update rpc-docs-tool to work with latest nightly rustdocNick Mathewson2024-10-221-1/+7
| | | | | Additionally, document that this tool requires particular versions of nightly, since the rustdoc json format is unstable.
* rpc-doc-tool: improvements to HTML_HEADERNick Mathewson2024-10-031-2/+4
|
* rpc-doc-tool: move constants to head of fileNick Mathewson2024-10-031-26/+26
|
* rpc-doc-tool: Use __file__ in place of argv[0]Nick Mathewson2024-10-031-4/+6
|
* rpc-doc-tool: Fix handling for "magic" headings.Nick Mathewson2024-10-021-4/+3
|
* add references for rustdoc links.Nick Mathewson2024-10-011-8/+45
|
* rpc-doc-tool: only emit Parameters link when there are some.Nick Mathewson2024-10-011-1/+15
|
* Python tool to build RPC method/type documentation.Nick Mathewson2024-10-011-0/+615
Uses the RPC library to extract a list of RPC methods and objects; uses rustdoc-nightly to extract documentation for them; outputs a markdown document.