1
0
mirror of https://github.com/rclone/rclone.git synced 2026-01-03 09:03:50 +00:00

build: improve backend docs autogenerated marker line

Replace custom rem hugo shortcode template with HTML comment. HTML comments are now
allowed in Hugo without enabling unsafe HTML parsing.

Improve the text in the comment: Remove unnecessary quoting, and avoid impression that
make backenddocs has to be run and results committed, since we have a lint check which
will then report error because we want to prevent manual changes in autogenerated sections.

Disable the markdownlint rule line-length on the autogenerated marker line.

Make the autogenerated marker detection a bit more robust.

See #8942 for more details.
This commit is contained in:
albertony
2025-11-04 14:56:55 +01:00
parent 8f74e7d331
commit 0f3aa17fb6
72 changed files with 152 additions and 149 deletions

View File

@@ -577,7 +577,7 @@ And this is equivalent to `/tmp/dir`
```
## Supported commands
{{< rem autogenerated start "- run make rcdocs - don't edit here" >}}
<!-- autogenerated start "- run make rcdocs - don't edit here" -->
### backend/command: Runs a backend command. {#backend-command}
This takes the following parameters:
@@ -2363,7 +2363,7 @@ supplied and if there is only one VFS in use then that VFS will be
used. If there is more than one VFS in use then the "fs" parameter
must be supplied.
{{< rem autogenerated stop >}}
<!-- autogenerated stop -->
## Accessing the remote control via HTTP {#api-http}