16 Commits

Author SHA1 Message Date
Christian Poessinger
269023845a Refactor "code-block:: console" to "code-block:: none" 2019-11-28 21:41:32 +01:00
Christian Poessinger
a71cdcec33 docs: remove all trailing whitespaces
Done via:
$ find . -name "*.rst" | xargs sed -i 's/[ \t]*$//'
2019-11-28 21:26:14 +01:00
Christian Poessinger
6aa3cbb611 Refactor "code-block:: sh" to "code-block:: console"
This will add proper new-lines into the rendered PDF. Before if it has
been a long line, not all content was preserved in the PDF.
2019-11-27 17:20:38 +01:00
Christian Poessinger
d497d30747
Merge pull request #150 from rebortg/cfgcmd
cfgcmd for better typing feeling
2019-11-24 21:40:39 +01:00
Robert Göhler
0c19693d3d Style: change .. cfcmd:: to ..cfgcmd:: 2019-11-24 21:26:34 +01:00
Robert Göhler
6a776ece0f contributing: add section to style guide 2019-11-24 21:13:46 +01:00
Christian Poessinger
101449f304 documentation: fix generation error in "code-block" directive
docs/contributing/documentation.rst:115: ERROR: Error in "code-block" directive:
1 argument(s) required, 0 supplied.

.. code-block::

  .. opcmd:: show protocols static arp

  Display all known ARP table entries spanning accross all interfaces

There is a missing "sh" statement after "code-block::"
2019-11-23 14:03:44 +01:00
Robert Göhler
f4c414ce4d add new directives "cfcmd" and "opcmd" 2019-11-23 14:00:52 +01:00
Christian Poessinger
db7ece47f0 contribution: fix code-block in documentation 2019-11-19 20:38:41 +01:00
Christian Poessinger
73edff0a21 Replace all RFC links with proper :rfc: syntax 2019-11-17 20:20:16 +01:00
Christian Poessinger
5cccf4c70c contribution: beautify documentation directory name 2019-11-17 19:37:19 +01:00
Christian Poessinger
9ca193f52a contribution: fix call to ..note:: 2019-11-11 17:01:10 +01:00
Christian Poessinger
0e33d4179a contribution: restructure entire chapter
- move subchapters to sub-sub chapters and try to have more internal
  references to e.g. commit rules.
2019-11-11 17:00:12 +01:00
Rob Thomas
b66cdf17ad contribution: fix Markdown leftovers 2019-11-10 20:42:50 +01:00
Christian Poessinger
4d42f5bfee contribution: fix errors when generating documentation chapter 2019-11-08 19:17:47 +01:00
Christian Poessinger
dc495cfb89 contribution: add guide how to participate in the documentation 2019-11-08 18:52:09 +01:00