diff --git a/README.rst b/README.rst index 53f84a4f..90fe6082 100644 --- a/README.rst +++ b/README.rst @@ -42,13 +42,13 @@ package documentation is located in 'doc/_build/'. Package Documentation --------------------- -A detailed documentation of the Json Preprocessor's Package can be found here: `thejsonpreprocessor.pdf `_ +A detailed documentation of the Json Preprocessor's Package can be found here: `Json-Preprocessor.pdf `_ Feedback -------- -To give us a feedback, you can send an email to `Thomas Pollerspöck `_ +To give us a feedback, you can send an email to `Thomas Pollerspöck `_ In case you want to report a bug or request any interesting feature, please don't hesitate to raise a ticket. @@ -56,14 +56,14 @@ hesitate to raise a ticket. Maintainers ----------- -`Thomas Pollerspöck `_ +`Thomas Pollerspöck `_ Contributors ------------ -`Mai Dinh Nam Son `_ +`Mai Dinh Nam Son `_ -`Tran Duy Ngoan `_ +`Tran Duy Ngoan `_ License ------- diff --git a/doc/_build/latex/thejsonpreprocessor.pdf b/doc/_build/latex/Json-Preprocessor.pdf similarity index 98% rename from doc/_build/latex/thejsonpreprocessor.pdf rename to doc/_build/latex/Json-Preprocessor.pdf index 282eaf27..18fbe515 100644 Binary files a/doc/_build/latex/thejsonpreprocessor.pdf and b/doc/_build/latex/Json-Preprocessor.pdf differ diff --git a/doc/additional_doc/feature_documentation.rst b/doc/additional_doc/feature_documentation.rst index 711a3465..62a4def3 100644 --- a/doc/additional_doc/feature_documentation.rst +++ b/doc/additional_doc/feature_documentation.rst @@ -235,9 +235,9 @@ parameters. User can update parameters which are already declared and add new pa or new element into existing parameters. The below example will show the way to do these features. -In case we have many different variants, and each varaint requires a different value -assigned to the parameter. This feature could help us update new value for existen -parameters, it also supports to add new parameters to existen configuation object. +In case we have many different variants, and each variant requires a different value +assigned to the parameter. This feature could help us update new value for existing +parameters, it also supports to add new parameters to existing configuation object. **Example:** @@ -407,10 +407,10 @@ The ``config.json`` file is handled by JsonPreprocessor package, then return the Feedback -------- -To give us a feedback, you can send an email to `Thomas Pollerspöck `_ or -`RBVH-ECM-Automation_Test_Framework-Associates `_ +To give us a feedback, you can send an email to `Thomas Pollerspöck `_ or +`RBVH-ECM-Automation_Test_Framework-Associates `_ -In case you want to report a bug or request any interesting feature, please don't hesitate to rasie a ticket on +In case you want to report a bug or request any interesting feature, please don't hesitate to raise a ticket on `our Jira `_ References diff --git a/doc/conf.py b/doc/conf.py index d9775b34..75c607a6 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -51,7 +51,8 @@ # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# Bosch specific addons: +# -- Options for TEX/PDF output ------------------------------------------------- + # Redefinition of text boxes (using LaTeX package 'tcolorbox' instead of the Sphinx internal 'sphinxlightbox' and 'sphinxheavybox') latex_additional_files = ["latex_addons/sphinxlatexadmonitions.sty"] # The original installation version of this file can be found here: @@ -59,6 +60,8 @@ # The latex_addons folder contains this file with the same name! # Reason: Because of too much dependencies and adaptions the complete file has to be exchanged! +latex_documents = [('index', 'Json-Preprocessor.tex', project, author, 'manual', False)] + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #