Add support for name version doc format libdoc

[krysalead]

This PR add the support of the following libdoc parameters

• Name: using the --name you can override the name of the library
• version: using --version you can specify the version
• doc-format: using the --doc-format you can specify the format of the doc.

Sorry if the code is not following the philosophy. I have also fixed the tests to work with Robot4.0

Regards

K

[MaciejWiczk]

Hi @krysalead, thanks for PR! Could I ask You to walk me through the situation, when You would like to load more than one library? Will all of them be overwritten by name, version and doc-format?

[Ka55i0peia]

@krysalead . Please note the relation to issue https://github.com/pbylicki/rfhub2/issues/55 .

I think the doc format might not be set explicit on cli. robot.libdoc is extracting it dynamic from resource it is going to read. (robot, if docing a robot resource file, or if specified in python using that format).

Back from a short holiday I'll try to push my employer to make suggestions/investigation I made in https://github.com/pbylicki/rfhub2/issues/55 public as pull request.

[krysalead]

Hi @MaciejWiczk there is multiple issues

1. There is no way to provide a version when the keyword are inside a robot file.
2. There is no way to easily link all the keywords of a library in the context of multi library documentation. This is not the best solution but an acceptable quick win. Ideally having "folders" will be quite interesting, also having the information about the name of the lib to be installed and then the reference to the path of the file to put in the "Settings" section of the robot test will be the perfect solution.
3. The format of the documentation we are using in Robot file seems to not being well rendered in the rfhub, due to the default format used by the testdoc lib.

So the goal of this PR is to allow an override of those information from the command line, if not it will still use the one detected. HI @Ka55i0peia, weird that libdoc is not properly detecting the format, carriage return are not kept and my doc is on a single line. My change is fixing that, maybe something I missed in my documentation.

[krysalead]

This is an example of my lib that contains files which are in the end inside multiple collection, so what I was looking for is a top level object called lets say library to group them

[MaciejWiczk]

Hi @krysalead let me go through things You mentioned below

Hi @MaciejWiczk there is multiple issues

1. There is no way to provide a version when the keyword are inside a robot file.

Yes, but that was default with LibDoc AFAIK

2. There is no way to easily link all the keywords of a library in the context of multi library documentation. This is not the best solution but an acceptable quick win. Ideally having "folders" will be quite interesting, also having the information about the name of the lib to be installed and then the reference to the path of the file to put in the "Settings" section of the robot test will be the perfect solution.

Combinig robot files in python library is a new approach for me. I have not tought about such a solution. And oribably LibDoc is handling that the same way that RfHub2 does. A workaround I can think of is to create LibDoc file and use it as a source for RfHub2 with version, name etc provided from LibDoc cli.

3. The format of the documentation we are using in Robot file seems to not being well rendered in the rfhub, due to the default format used by the testdoc lib.

I know, and hopefully things will be adressed in future

So the goal of this PR is to allow an override of those information from the command line, if not it will still use the one detected.

This must be handled with more attention. RfHub2-cli was created mainly for batch mode and to relieve user from thinking. Your changes are targeted for single library in mind.

HI @Ka55i0peia, weird that libdoc is not properly detecting the format, carriage return are not kept and my doc is on a single line. My change is fixing that, maybe something I missed in my documentation.

Could You show me the line with changes? I just got back form time off and I'am still a bit puzzled