Skip to content

Commit

Permalink
Add pandoc with wget suggestion to docs
Browse files Browse the repository at this point in the history
Signed-off-by: Jorge Marques <[email protected]>
  • Loading branch information
gastmaier committed Sep 24, 2024
1 parent 545172f commit 6f23fe7
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/docs_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,19 @@ format (see :ref:`tables` for more information).
After converting, update it to better conform with the guidelines below, and
make sure to use our directives and roles, for example, the :ref:`role git`.

To speed thing up, combine with wget:

.. code:: bash
wikifile=resources/eval/user-guides/adrv9009/adrv9009
outfile=output.rst
wget -O - https://wiki.analog.com/$wikifile?do=export_raw --no-verbose | \
pandoc -f dokuwiki -t rst --columns=80 -s -o $outfile --list-tables
Also, consider recording macros in your favorite text editor to automate
repetitive steps.

Indentation
--------------------------------------------------------------------------------

Expand Down Expand Up @@ -299,7 +312,7 @@ while respecting word-breaks:
cat imported.txt | fold -sw 80 > imported.rst
The header divide ("`---`" shall be either 80 characters wide or end at the
The header divider "``---``" shall be either 80 characters wide or end at the
title character, that means, this is also valid:

.. code::
Expand Down

0 comments on commit 6f23fe7

Please sign in to comment.