Commit Graph

24 Commits

Author SHA1 Message Date
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
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
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
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
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
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
pancho horrillo
8248627f04 doc: misc fixes
Co-authored-by: Luis Saiz <luis.saiz@bbva.com>
2019-11-29 12:57:45 +01:00
luissaiz
b0c8b74e63 Update index.rst (#97) 2019-11-29 11:56:14 +01:00
pancho horrillo
53b326cb7b doc: style fixes, example code fixes and clarifications 2019-11-27 16:07:23 +01:00
pancho horrillo
530fad17c9 doc: fix typo 2019-11-27 07:53:56 +01:00
cr0hn
cfbb2ef6cb Merged greet-json & upload examples 2019-11-22 12:15:33 +01:00
cr0hn
4c2ff45a84 Merge remote-tracking branch 'origin/master'
# Conflicts:
#	docs/source/examples/index.rst
2019-11-22 12:00:02 +01:00
cr0hn
d52137bce8 typos & new examples 2019-11-22 11:59:21 +01:00
pancho horrillo
24cc530a0e doc: add missing quotes in example
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
2019-11-21 13:12:19 +01:00
pancho horrillo
8f876ba7db doc: fix a couple of typos and drop spurious whitespace 2019-11-21 10:36:46 +01:00
Roberto Abdelkader Martínez Pérez
7e7c536e78 Testing documentation redering 2019-11-21 08:53:28 +01:00
cr0hn
c6c0dd7c48 add 2 more examples 2019-11-20 15:18:00 +01:00
cr0hn
0de07c1132 new examples 2019-11-20 12:56:41 +01:00
Roberto Abdelkader Martínez Pérez
4492bfdf54 Finish merge and recover README 2019-11-19 16:50:41 +01:00