Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1,102 Commits 1 Branch 0 Tags
121d8cefda06ec61c2c8b96b2c8f9a19bdb8025d
Commit Graph

232 Commits

Author SHA1 Message Date
pancho horrillo
cc6816faf9 doc: markup :option: role as :nref-option: role to prevent sphinx warnings 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 16:02:49 +01:00
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
Roberto Abdelkader Martínez Pérez
d7f4293d15 Add new default role tech and the provisional nref-option role 
Co-authored-by: pancho horrillo <pedrofelipe.horrillo@bbva.com>
 2019-12-11 15:53:54 +01:00
pancho horrillo
e84681d828 doc: markup find as command role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 15:24:36 +01:00
pancho horrillo
0a0dd9d416 Revert "Set Sphinx default_role to allow single backslash to be render as 'option' role." 
This reverts commit 2de227e59c.

This does not fix the issue we are having with :any: roles.
 2019-12-11 15:24:36 +01:00
Roberto Abdelkader Martínez Pérez
2de227e59c Set Sphinx default_role to allow single backslash to be render as 'option' role. 2019-12-11 14:54:09 +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
b7ec9815aa doc: markup cat as command role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 14:20:57 +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
11383d456a doc: markup JSON as any role (part II) 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 13:17:55 +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
09e842f199 doc: markup JSON and HTTP API as any role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 13:05:39 +01:00
pancho horrillo
4102834167 doc: italizice Kapow! in title 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 12:51:58 +01:00
pancho horrillo
5fa3a2489a doc: markup Go as any role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 12:50:45 +01:00
pancho horrillo
d69e7b90e7 doc: markup ping.pow as file role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 12:46:50 +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
1cb328646e doc: markup ping as program role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 12:16:41 +01:00
pancho horrillo
8742ee9667 doc: markup ls as command role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 11:44:32 +01:00
pancho horrillo
45de867b2d doc: markup jq as program role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 11:43:04 +01:00
pancho horrillo
4d2f0af941 doc: markup curl as program role 
See ¹.

¹: https://www.sphinx-doc.org/en/1.5/markup/inline.html#role-program

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 11:43:04 +01:00
pancho horrillo
3bed9924d5 doc: make example script downloadable 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@bbva.com>
 2019-12-11 10:45:48 +01:00
Roberto Abdelkader Martínez Pérez
5364b31603 Come on, you have to write some code... :) 2019-12-11 08:24:42 +01:00
pancho horrillo
375cf7e912 doc: fix title 2019-12-11 03:37:19 +01:00
pancho horrillo
ec4143393a doc: tweak code-block language to activate syntax highlighting 2019-12-11 03:35:12 +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
9436548d7b doc: normalize code-block type 2019-12-11 03:13:28 +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
deceadcc49 doc: misc fixes 2019-12-11 02:49:37 +01:00
pancho horrillo
e6cb0f1fa6 doc: fix typo and rst style fixes 
As per the official docs¹, we should use ``code`` instead of :samp:`code`,
since we are not enhancing variables inside.

:samp:
A piece of literal text, such as code. Within the contents, you can use curly
braces to indicate a “variable” part, as in file. For example, in :samp:`print
1+{variable}`, the part variable would be emphasized.

If you don’t need the “variable part” indication, use the standard ``code``
instead.

¹: https://www.sphinx-doc.org/en/1.5/markup/inline.html#role-samp
 2019-12-11 02:37:56 +01:00
pancho horrillo
16639ba44b doc: style fixes 2019-12-11 02:32:52 +01:00
pancho horrillo
37025211b1 doc: style fixes 2019-12-11 02:06:31 +01:00
pancho horrillo
ef838c4a25 doc: style fix 2019-12-10 18:23:23 +01:00
pancho horrillo
ba6006fdf5 doc: fix typo 2019-12-10 18:15:29 +01:00
pancho horrillo
a9328fe706 doc: consistent naming of pow files 2019-12-10 18:10:31 +01:00
pancho horrillo
ae68cf8fed doc: tutorial style fixes 2019-12-10 18:01:54 +01:00
pancho horrillo
99167e8627 doc: tutorial background story fixes 2019-12-10 16:19:06 +01:00
pancho horrillo
cbacacf8e1 doc: tutorial background story fixes 2019-12-10 16:15:40 +01:00
pancho horrillo
b4bc08f491 doc: typos and style fixes 2019-12-10 16:09:35 +01:00
Roberto Abdelkader Martínez Pérez
84e481f78f Fix nonworking examples 2019-12-10 15:13:29 +01:00
Roberto Abdelkader Martínez Pérez
62570048af Use tabs in HEREDOC blocks 2019-12-10 14:43:51 +01:00
Roberto Abdelkader Martínez Pérez
deb94f1b49 Fix tutorial examples 2019-12-10 12:34:13 +01:00
Roberto Abdelkader Martínez Pérez
5291084c8c Download and chmod instructions for tutorial backup script 2019-12-10 12:15:44 +01:00
Roberto Abdelkader Martínez Pérez
0848dc212c Fake backup script to be used together with the tutorial. 2019-12-10 12:13:05 +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
Roberto Abdelkader Martínez Pérez
7dc1d5db21 Add index.rst to side panel 2019-12-10 09:59:01 +01:00
Roberto Abdelkader Martínez Pérez
27569cf50c Review examples against option substitution. 
Co-authored-by: pancho horrillo <pedrofelipe.horrillo@bbva.com>
 2019-12-10 09:11:57 +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
Roberto Abdelkader Martínez Pérez
73ede15929 Install binary always as 'kapow' 2019-12-03 09:02:27 +01:00