doc/index.rst
author Andrey Skvortsov <andrej.skvortzov@gmail.com>
Fri, 15 Jun 2018 16:12:50 +0300
changeset 2184 bbd2364fbf71
parent 811 66a8812457d6
child 3925 1d383b4c0a23
permissions -rw-r--r--
Add argument to set list of source files to check

This is necessary, in case you want to use docker run in pretxncommit
Mercurial hook. Unfortunately for some reason if hg running in
container can't find just created commit defined by $HG_NODE. And it
throws error 'unknown revision'.

Here is example for hgrc.

[hooks]
pretxncommit.linter = hg status -m -n -a -n -I '**.py' --change $HG_NODE > files.lst && docker run --volume=$PWD:/beremiz --workdir="/beremiz" --volume=$PWD/../CanFestival-3:/CanFestival-3 --memory=1g --entrypoint=/beremiz/tests/tools/check_source.sh skvorl/beremiz-requirements --files-to-check files.lst
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     1
.. Beremiz documentation master file
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     2
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     3
Beremiz's documentation
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     4
=======================
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     5
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     6
Contents:
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     7
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     8
.. toctree::
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     9
   :maxdepth: 2
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    10
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    11
   overview
811
66a8812457d6 Added subdirectories in documentation, with more deoctree items to test. Enabled i18n in sphinx doc, tested with a small french translation
Edouard Tisserant
parents: 810
diff changeset
    12
   manual/index
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    13
   standards
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    14