Skip to content

Commit

Permalink
docs(autodoc) update autodoc templates to reflect manual changes
Browse files Browse the repository at this point in the history
* Most of these changes involve changing the syntax of the "Back to TOC
  / top" links
* Some of the regenerated pages also required a new flag to not include
  reading time
  • Loading branch information
kikito committed May 13, 2020
1 parent a816288 commit 7006f4b
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 14 deletions.
9 changes: 5 additions & 4 deletions autodoc-cli/data.lua
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ local data = {}
data.header = [[
---
#
# WARNING: this file was auto-generated by a script.\n")
# DO NOT edit this file directly. Instead, send a pull request to change\n")
# the files in https://github.com/Kong/docs.konghq.com/tree/master/autodoc-cli\n")
# WARNING: this file was auto-generated by a script.
# DO NOT edit this file directly. Instead, send a pull request to change
# the files in https://github.com/Kong/docs.konghq.com/tree/master/autodoc-cli
#
title: CLI Reference
skip_read_time: true
---
## Introduction
Expand All @@ -26,7 +27,7 @@ All commands take a set of special, optional flags as arguments:
* `--v`: enable verbose mode
* `--vv`: enable debug mode (noisy)
[Back to TOC](#table-of-contents)
[Back to top](#introduction)
## Available commands
Expand Down
2 changes: 1 addition & 1 deletion autodoc-cli/run.lua
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ for _, cmd in ipairs(cmds) do
pd:close()
write("```")
write("")
write("[Back to TOC](#table-of-contents)")
write("[Back to top](#introduction)")
write("")
write("---")
write("")
Expand Down
9 changes: 5 additions & 4 deletions autodoc-conf/data.lua
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ local data = {}

data.header = [[
---
title: Configuration Reference
#
# WARNING: this file was auto-generated by a script.\n")
# DO NOT edit this file directly. Instead, send a pull request to change\n")
# the files in https://github.com/Kong/docs.konghq.com/tree/master/autodoc-conf\n")
# WARNING: this file was auto-generated by a script.
# DO NOT edit this file directly. Instead, send a pull request to change
# the files in https://github.com/Kong/docs.konghq.com/tree/master/autodoc-conf
#
title: Configuration Reference
skip_read_time: true
---
## Configuration loading
Expand Down
14 changes: 9 additions & 5 deletions ldoc/ldoc.ltp
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@
>
---
#
# WARNING: this file was auto-generated by a script.\n")
# DO NOT edit this file directly. Instead, send a pull request to change\n")
# https://github.com/Kong/docs.konghq.com/tree/master/ldoc.ltp\n")
# WARNING: this file was auto-generated by a script.
# DO NOT edit this file directly. Instead, send a pull request to change
# https://github.com/Kong/docs.konghq.com/tree/master/ldoc.ltp
# or its associated files
#
title: $(module.name)
Expand Down Expand Up @@ -189,9 +189,13 @@ $(trim(usage))
> end -- for usage
> end -- if usage

[Back to TOC](#table-of-contents)

> if module.name == "PDK" then
[Back to top](#plugin-development-kit)
> else
[Back to top](#$(ldoc.no_spaces(module.name):gsub("_", "")))
> end
> end -- if not item.tags.redirect

> end -- for items
> end -- if has_content(items)
> end -- for kinds

0 comments on commit 7006f4b

Please sign in to comment.