Commit Graph

12 Commits

Author SHA1 Message Date
pancho horrillo
ab615e2276 doc: markup :any: role as default role, which is now :tech: (custom)
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 15:59:27 +01:00
pancho horrillo
cb5ba7db43 doc: markup {User,Control,Data} HTTP Interface as role any
Also markup localhost:8080 as code, for consistency.

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 14:41:14 +01:00
pancho horrillo
bd1ea8f746 doc: markup 'kapow server' as code
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 14:32:12 +01:00
pancho horrillo
578e4c3b30 doc: markup envvars as such, HANDLER_ID as variable
HANDLER_ID represents a variable name in this case, and the docs¹, first Note,
suggest using the default role (`content`) for variable names.

¹: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 13:29:18 +01:00
pancho horrillo
8b3417000d doc: style fix 2019-12-11 13:16:46 +01:00
pancho horrillo
90f97f63fa doc: markup Docker{,file} as any role
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 13:15:45 +01:00
pancho horrillo
171f8c0410 doc: markup kapow as program role
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 12:41:18 +01:00
pancho horrillo
b1d0e9c92f doc: use valid language in code-blocks
See ¹ for the valid values.

¹: https://www.sphinx-doc.org/en/1.5/markup/code.html#directive-code-block
2019-12-11 03:23:56 +01:00
pancho horrillo
c974e7787e doc: tweak code-block to fix render glitch at readthedocks.io 2019-12-11 03:10:55 +01:00
pancho horrillo
16639ba44b doc: style fixes 2019-12-11 02:32:52 +01:00
pancho horrillo
bb4aa1a00f doc: normalize style of Kapow!, to be shown italicized
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-10 10:34:39 +01:00
pancho horrillo
166c767317 doc: add section on security and misc fixes
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-05 18:30:35 +01:00