1
0
mirror of https://github.com/rclone/rclone.git synced 2025-11-23 21:44:49 +02: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

@@ -137,7 +137,7 @@ or:
rclone lsd :http,url='https://beta.rclone.org':
```
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/http/http.go then run make backenddocs" >}}
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/http/http.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options
Here are the Standard options specific to http (HTTP).
@@ -287,7 +287,7 @@ will default to those currently in use.
It doesn't return anything.
{{< rem autogenerated options stop >}}
<!-- autogenerated options stop -->
## Limitations