RobotFramework AIO documentation

The RobotFramework AIO documentation is available as PDF file and can be found here: RobotFrameworkAIO_Reference.pdf

The documentation consists of two parts:

1. Common description
2. Description of the interfaces of RobotFramework AIO components

The RobotFramework AIO documentation can be build either with genmaindoc.py immediately or with setup.py indirectly. The difference is that genmaindoc.py only builds the documentation, whereas setup.py additionally installs the documentation in

python39\Lib\site-packages\RobotFrameworkAIO

The execution of setup.py includes the execution of genmaindoc.py.

Some preparations are necessary before genmaindoc.py or setup.py can be executed:

1. Install a LaTeX compiler (full installation of Texlive recommended)

2. Clone the robotframework-documentation repository to your computer.

   git clone https://github.com/test-fullautomation/robotframework-documentation.git
   

3. Clone all repositories containing components that shall be part of the documentation, to your computer.

4. Add relative paths to these repositories to the genmaindoc configuration files inside: maindoc/maindoc_configs, section "IMPORTS":

   "IMPORTS" : ["../../../python-genpackagedoc",
                "../../../python-extensions-collection",
                ...
   

5. Prepare the genmaindoc.py command line

   genmaindoc.py requires the following command line parameters:

   • --configfile : Path and name of maindoc configuration file
   • --bundle_name : The name of the entire framework bundle
   • --bundle_version : The version of the entire framework bundle
   • --bundle_version_date : The version date of the entire framework bundle

   In case of genmaindoc.py is called by setup.py, a direct way to define command line parameter for genmaindoc.py is not possible (it's not intended to intermix genmaindoc and setuptools command lines).

   Therefore setup.py requires for every single command line parameter a corresponding environment variable.

   Under Windows the environment can be prepared e.g. in the following way:

   set MAINDOC_CONFIGFILE=--configfile "./maindoc/maindoc_configs/maindoc_config_OSS.json"
   set BUNDLE_NAME=--bundle_name "RobotFramework AIO"
   set BUNDLE_VERSION=--bundle_version "0.7.0"
   set BUNDLE_VERSION_DATE=--bundle_version_date "03.2023"
   

   The values are taken over to the resulting PDF file (e.g. in the title page).

6. Introduce an environment variable "GENDOC_LATEXPATH" containing the path to the LaTeX interpreter pdflatex.exe (Windows) / pdflatex (Linux).

   This has to be configured in the genmaindoc configuration, section "TEX":

   "TEX" : {
            "WINDOWS" : "%GENDOC_LATEXPATH%/pdflatex.exe",
            "LINUX"   : "${GENDOC_LATEXPATH}/pdflatex"
           }
   

7. Use the following command to build and install the documentation:

   setup.py install
   

   The output can be found here:

   RobotFrameworkAIO\RobotFrameworkAIO_Reference.pdf
   

   The name of the PDF file is defined in the genmaindoc configuration.

Feedback

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.

Maintainers

Thomas Pollerspöck

Contributors

License

Copyright 2020-2024 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

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.