From b9e9c448b78f7858be55315546d1bd4d7acb1a1d Mon Sep 17 00:00:00 2001 From: Neda Moeini <neda.moeini@geant.org> Date: Mon, 24 Mar 2025 14:16:47 +0100 Subject: [PATCH] update docs. --- docs/source/conf.py | 21 +++++++++++---------- docs/source/validations.rst | 6 +++++- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 57b2530..38af583 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,6 +12,7 @@ # import os import sys + import django sys.path.insert(0, os.path.abspath("../../")) @@ -20,12 +21,12 @@ django.setup() # -- Project information ----------------------------------------------------- -project = 'Sage Validation' -copyright = '2024, GÉANT' -author = 'GÉANT' +project = "Sage Validation" +copyright = "2024, GÉANT" +author = "GÉANT" # The full version, including alpha/beta/rc tags -release = '0.1' +release = "0.1" # -- General configuration --------------------------------------------------- @@ -34,13 +35,13 @@ release = '0.1' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.napoleon', - 'sphinx_autodoc_typehints', + "sphinx.ext.autodoc", + "sphinx.ext.napoleon", + "sphinx_autodoc_typehints", ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -53,9 +54,9 @@ exclude_patterns = [] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = "alabaster" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ["_static"] diff --git a/docs/source/validations.rst b/docs/source/validations.rst index 13bcc92..5f2042c 100644 --- a/docs/source/validations.rst +++ b/docs/source/validations.rst @@ -60,4 +60,8 @@ The following table describes the validation rules applied when uploading a CSV * - Checks - `...TaxRate` - Validate against `[Tax code]` in `dbo.meoValidVAT`. - - Ensure valid tax rates. \ No newline at end of file + - Ensure valid tax rates. + + * - Checks + - `ChequeCurrencyName`, `ChequeToBankExchangeRate`, `ChequeValueInChequeCurrency` + - Cheque fields must be empty. \ No newline at end of file -- GitLab