From fc2d6441596e547ba8d8c9957b092724d8bb9ae3 Mon Sep 17 00:00:00 2001 From: jwansek Date: Thu, 28 Apr 2022 17:52:47 +0100 Subject: Started writing documentation --- docs/source/configfile.rst | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/source/configfile.rst (limited to 'docs/source/configfile.rst') diff --git a/docs/source/configfile.rst b/docs/source/configfile.rst new file mode 100644 index 0000000..646230f --- /dev/null +++ b/docs/source/configfile.rst @@ -0,0 +1,39 @@ +.. _configfile: + +``smarker.conf``: Configuration File +==================================== + +Here is what it should look like. It needs to be in the same directory as the +source code. Its a standard .ini format. + +Once it's been created, you can safely forget about it since all of the options +can be over-ridden in command line arguments.:: + + [mysql] + host = vps.eda.gay + port = 3307 + user = root + passwd = ************ + + [tex] + columns = 1 + show_full_docs = True + show_source = True + show_all_regex_occurrences = True + show_all_run_output = True + + [md] + show_full_docs = False + show_source = False + show_all_regex_occurrences = True + show_all_run_output = False + + [txt] + show_full_docs = False + show_source = False + show_all_regex_occurrences = True + show_all_run_output = False + +The first block configures where your SQL server is. The other options are +the default options when generating reports. ``[tex]`` options are inherited +for rendering to PDF. \ No newline at end of file -- cgit v1.2.3