Skip to content

Qth2hi/task/documentation and sphinx config maintenance #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 10, 2022
Merged

Qth2hi/task/documentation and sphinx config maintenance #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
651fe13
- Predefined the name of output file (.tex/.pdf file of Sphinx and La…
HolQue Feb 10, 2022
8c73bfc
- Provided renamed PDF file
HolQue Feb 10, 2022
8ad605f
- Adaptions in README.rst (mail addresses, pdf file name)
HolQue Feb 10, 2022
cd4d576
- fixed some typing issues in feature_documentation.rst
HolQue Feb 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,28 +42,28 @@ package documentation is located in 'doc/_build/'.
Package Documentation
---------------------

A detailed documentation of the Json Preprocessor's Package can be found here: `thejsonpreprocessor.pdf <https://github.com/test-fullautomation/python-jsonpreprocessor/blob/qth2hi/task/documentation_and_sphinx_config_maintenance/doc/_build/latex/thejsonpreprocessor.pdf>`_
A detailed documentation of the Json Preprocessor's Package can be found here: `Json-Preprocessor.pdf <https://github.com/test-fullautomation/python-jsonpreprocessor/blob/qth2hi/task/documentation_and_sphinx_config_maintenance/doc/_build/latex/Json-Preprocessor.pdf>`_


Feedback
--------

To give us a feedback, you can send an email to `Thomas Pollerspöck <Thomas.Pollerspoeck@de.bosch.com>`_
To give us a feedback, you can send an email to `Thomas Pollerspöck <mailto:Thomas.Pollerspoeck@de.bosch.com>`_

In case you want to report a bug or request any interesting feature, please don't
hesitate to raise a ticket.

Maintainers
-----------

`Thomas Pollerspöck <Thomas.Pollerspoeck@de.bosch.com>`_
`Thomas Pollerspöck <mailto:Thomas.Pollerspoeck@de.bosch.com>`_

Contributors
------------

`Mai Dinh Nam Son <son.maidinhnam@vn.bosch.com>`_
`Mai Dinh Nam Son <mailto:son.maidinhnam@vn.bosch.com>`_

`Tran Duy Ngoan <Ngoan.TranDuy@vn.bosch.com>`_
`Tran Duy Ngoan <mailto:Ngoan.TranDuy@vn.bosch.com>`_

License
-------
Expand Down
Binary file renamed doc/_build/latex/thejsonpreprocessor.pdf → doc/_build/latex/Json-Preprocessor.pdf
View file
Open in desktop
Binary file not shown.
12 changes: 6 additions & 6 deletions doc/additional_doc/feature_documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down Expand Up @@ -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 <Thomas.Pollerspoeck@de.bosch.com>`_ or
`RBVH-ECM-Automation_Test_Framework-Associates <RBVH-ENG2-CMD-Associates@bcn.bosch.com>`_
To give us a feedback, you can send an email to `Thomas Pollerspöck <mailto:Thomas.Pollerspoeck@de.bosch.com>`_ or
`RBVH-ECM-Automation_Test_Framework-Associates <mailto:RBVH-ENG2-CMD-Associates@bcn.bosch.com>`_

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 <https://rb-tracker.bosch.com/tracker01/projects/ROBFW/summary>`_

References
Expand Down
5 changes: 4 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,17 @@
# 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:
# <Python installation path>\Lib\site-packages\sphinx\texinputs\sphinxlatexadmonitions.sty
# 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.
#
Expand Down