Commit Graph

47 Commits

Author SHA1 Message Date
pancho horrillo
7b7c7dcf8c docs: add note to windows setup 2019-12-17 15:27:50 +01:00
pancho horrillo
6986496185 docs: tweak installation instructions 2019-12-17 14:24:41 +01:00
Héctor Hurtado
9948036c47 Add renaming to Windows installation instructions 2019-12-17 11:12:02 +01:00
Roberto Abdelkader Martínez Pérez
772de0b039 docs: Use sphinx version variable to render an always correct Kapow! Dockerfile 2019-12-17 09:57:27 +01:00
Roberto Abdelkader Martínez Pérez
c2c97997cd docs: Extract current version from git and use it in the install instructions. 2019-12-17 09:50:51 +01:00
Roberto Abdelkader Martínez Pérez
7f6e244f61 docs: Correct installation instructions for Linux 2019-12-17 09:24:08 +01:00
Roberto Abdelkader Martínez Pérez
01726df4e8 doc: Restructure to allow better latex rendering 2019-12-16 11:00:36 +01:00
pancho horrillo
dea72cbe3a doc: style fixes and links 2019-12-13 15:08:02 +01:00
pancho horrillo
45de5a55e8 doc: style fixes 2019-12-13 12:35:48 +01:00
pancho horrillo
7f9e9de1d2 doc: add missing links and roles 2019-12-13 12:24:36 +01:00
pancho horrillo
e78af66c12 doc: markup ping as command role, not program role
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 17:56:28 +01:00
pancho horrillo
10cccca55d doc: add links and polish the_project/*
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 17:45:01 +01:00
pancho horrillo
0fd3cfb665 doc: add internal links
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 17:44:10 +01:00
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
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
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
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
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
b4bc08f491 doc: typos and style fixes 2019-12-10 16:09:35 +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
Roberto Abdelkader Martínez Pérez
73ede15929 Install binary always as 'kapow' 2019-12-03 09:02:27 +01:00
pancho horrillo
8248627f04 doc: misc fixes
Co-authored-by: Luis Saiz <luis.saiz@bbva.com>
2019-11-29 12:57:45 +01:00
luissaiz
b3d4bffdf5 doc: fix typos (#96)
Misuse of "lets".

Co-authored-by: Luis Saiz <luis.saiz@bbva.com>
2019-11-29 12:08:06 +01:00
pancho horrillo
2e1455cb61 Revert "Update quickstart.rst"
This reverts commit 7fab8ae529.
2019-11-29 10:20:40 +01:00
luissaiz
7fab8ae529 Update quickstart.rst 2019-11-29 09:48:10 +01:00
pancho horrillo
53b326cb7b doc: style fixes, example code fixes and clarifications 2019-11-27 16:07:23 +01:00
Héctor Hurtado
6fe92ede28 Fix some formatting bugs 'The Project' section 2019-11-27 10:37:54 +01:00
Héctor Hurtado
e29c56067b Fix some formatting bugs 'The Project' section 2019-11-27 10:19:21 +01:00
Héctor Hurtado
a3832977e4 Fix some formatting bugs 'The Project' section 2019-11-27 10:15:55 +01:00
Héctor Hurtado
d3489d1b4b Fix some formatting bugs 'The Project' section 2019-11-27 10:08:10 +01:00
Héctor Hurtado
1e0ba8d7e8 Fix some typos in 'The Project' section 2019-11-27 10:05:57 +01:00
Héctor Hurtado
3f62a833cd Fix some typos in 'The Project' section 2019-11-27 10:04:46 +01:00
Héctor Hurtado
da693d32b8 Fix some typos in 'The Project' section 2019-11-27 10:02:35 +01:00
Héctor Hurtado
aacbd3388a Fix some typos in 'The Project' section 2019-11-27 10:00:22 +01:00
Héctor Hurtado
65e41405ef Fix some typos in 'The Project' section 2019-11-27 09:09:08 +01:00
Héctor Hurtado
4f2c8f3468 Fix some typos in 'The Project' section 2019-11-27 08:53:50 +01:00
cr0hn
f1fd6086ba updated quickstart and index 2019-11-26 12:55:09 +01:00
cr0hn
f7139cd489 new folder for landing pages
updated index
add new image
2019-11-26 11:46:15 +01:00