Commit Graph

171 Commits

Author SHA1 Message Date
Roberto Abdelkader Martínez Pérez
3cfc7e21ba doc: Put examples into categories. Parameter injection example moved to security concerns instead (#101) 2019-12-19 16:32:56 +01:00
Roberto Abdelkader Martínez Pérez
e6c6edf6b0 doc: Link data api section 2019-12-19 11:38:21 +01:00
Roberto Abdelkader Martínez Pérez
197f91821a doc: Missing subsection in philosophy section 2019-12-19 11:32:49 +01:00
pancho horrillo
7b7c7dcf8c docs: add note to windows setup 2019-12-17 15:27:50 +01:00
pancho horrillo
709276327a chores: prepare release v0.3.0
* Drop docs/release-notes/RELEASE-v0.3.0-rc5.md
* Update release-key.gpg
2019-12-17 15:11:03 +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
91aff009b0 doc: Remove custom latex rst parts from exclude to avoid compilation problems 2019-12-16 11:59:36 +01:00
Roberto Abdelkader Martínez Pérez
9509d7b275 doc: Remove warning about unused rst files (they are used in latex build) 2019-12-16 11:03:47 +01:00
Roberto Abdelkader Martínez Pérez
01726df4e8 doc: Restructure to allow better latex rendering 2019-12-16 11:00:36 +01:00
Héctor Hurtado
9a52a7192a Resolve conflicts 2019-12-16 10:42:30 +01:00
pancho horrillo
cf3988fc22 chores: add v0.3.0-rc5 release notes 2019-12-13 22:50:16 +01:00
pancho horrillo
a724a35bdc docs: release notes: bump go release used to produce artifacts 2019-12-13 20:14:19 +01:00
pancho horrillo
c1c42982e2 docs: move release notes into docs/release-notes 2019-12-13 19:53:59 +01:00
pancho horrillo
3c05e3b580 doc: drop already resolved todo block 2019-12-13 16:09:52 +01:00
pancho horrillo
24f0597c95 doc: add link 2019-12-13 16:07:47 +01:00
pancho horrillo
3149554ff1 doc: add links and style fixes 2019-12-13 16:03:49 +01:00
pancho horrillo
74d9129d27 doc: add link 2019-12-13 15:43:51 +01:00
pancho horrillo
66eda3c6bd doc: drop stale todo block 2019-12-13 15:36:41 +01:00
pancho horrillo
b32d670251 doc: style fix 2019-12-13 15:35:20 +01:00
pancho horrillo
04ec4f2c41 doc: style fixes 2019-12-13 15:33:17 +01:00
pancho horrillo
b0d0c12981 doc: add links and roles 2019-12-13 15:27:21 +01:00
pancho horrillo
3bb0205ad1 doc: style fixes 2019-12-13 15:14:35 +01:00
pancho horrillo
2847073519 doc: drop explicit :tech: role 2019-12-13 15:10:17 +01:00
pancho horrillo
dea72cbe3a doc: style fixes and links 2019-12-13 15:08:02 +01:00
pancho horrillo
08086ee66e doc: style fixes 2019-12-13 12:37:12 +01:00
pancho horrillo
45de5a55e8 doc: style fixes 2019-12-13 12:35:48 +01:00
pancho horrillo
7b61c182f0 doc: style fixes 2019-12-13 12:33:14 +01:00
pancho horrillo
7f9e9de1d2 doc: add missing links and roles 2019-12-13 12:24:36 +01:00
pancho horrillo
b9f42bc458 doc: fix code style in titles
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 18:18:05 +01:00
pancho horrillo
f57df90347 doc: fix broken link
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 18:17:46 +01:00
pancho horrillo
5a18f84f9e doc: fix style
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 18:10:29 +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
ecaea23d40 doc: markup stdin as tech role
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-12-11 16:05:55 +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
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