Merge pull request #12 from test-fullautomation/HolQue/task/documenta…

…tion_and_sphinx_config_maintenance Maintenance:
test-fullautomation · Mar 7, 2022 · a4143e7 · a4143e7
2 parents 39f8459 + 2bd727a
commit a4143e7
Show file tree

Hide file tree

Showing 11 changed files with 91 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,82 @@
+> Licensed under the Apache License, Version 2.0 (the \"License\"); you
+> may not use this file except in compliance with the License. You may
+> obtain a copy of the License at
+>
+> <http://www.apache.org/licenses/LICENSE-2.0>
+>
+> Unless required by applicable law or agreed to in writing, software
+> distributed under the License is distributed on an \"AS IS\" BASIS,
+> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+> implied. See the License for the specific language governing
+> permissions and limitations under the License.
+
+# Json Preprocessor\'s Package Description
+
+## Getting Started
+
+The JsonPreprocessor is a Python3 package which allows programmers to
+handle additional features in json files such as
+
+-   add comments
+-   import other json files
+-   overwrite already existing parameters with new values
+
+These json files will be handled by the JsonPreprocessor which returns
+as result a dictionary object of the deserialized data.
+
+## How to install
+
+Firstly, clone **python-jsonpreprocessor** repository to your machine.
+
+Then go to python-jsonpreprocessor, using the 2 common commands below to
+build or install this package:
+
+``` 
+setup.py build      will build the package underneath 'build/'
+setup.py install    will install the package
+```
+
+After the build processes is completed, the package is located in
+\'build/\', and the generated package documentation is located in
+\'doc/\_build/\'.
+
+## Package Documentation
+
+A detailed documentation of the Json Preprocessor\'s package can be
+found here:
+[Json-Preprocessor.pdf](https://github.com/test-fullautomation/python-jsonpreprocessor/blob/develop/doc/_build/latex/Json-Preprocessor.pdf)
+
+## Feedback
+
+To give us a feedback, you can send an email to [Thomas
+Pollerspöck](mailto:[email protected])
+
+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](mailto:[email protected])
+
+## Contributors
+
+[Mai Dinh Nam Son](mailto:[email protected])
+
+[Tran Duy Ngoan](mailto:[email protected])
+
+## License
+
+Copyright 2020-2022 Robert Bosch GmbH
+
+Licensed under the Apache License, Version 2.0 (the \"License\"); you
+may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+
+> [![License: Apache
+> v2](https://img.shields.io/pypi/l/robotframework.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an \"AS IS\" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/README.rst b/README.rst
@@ -1,4 +1,4 @@
-.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+.. Copyright 2020-2022 Robert Bosch GmbH
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/config/CConfig.py b/config/CConfig.py
@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+#  Copyright 2020-2022 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

diff --git a/config/CExtendedSetup.py b/config/CExtendedSetup.py
@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+#  Copyright 2020-2022 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

diff --git a/doc/CJsonPreprocessor.rst b/doc/CJsonPreprocessor.rst
@@ -1,4 +1,4 @@
-.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+.. Copyright 2020-2022 Robert Bosch GmbH
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/doc/_build/latex/Json-Preprocessor.pdf b/doc/_build/latex/Json-Preprocessor.pdf
diff --git a/doc/additional_doc/feature_documentation.rst b/doc/additional_doc/feature_documentation.rst
@@ -1,4 +1,4 @@
-.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+.. Copyright 2020-2022 Robert Bosch GmbH
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/doc/conf.py b/doc/conf.py
@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+#  Copyright 2020-2022 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

diff --git a/doc/index.rst b/doc/index.rst
@@ -1,4 +1,4 @@
-.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+.. Copyright 2020-2022 Robert Bosch GmbH
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/setup.py b/setup.py
@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+#  Copyright 2020-2022 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

diff --git a/sphinx-makeall.py b/sphinx-makeall.py
@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+#  Copyright 2020-2022 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.