documentation not directly accesible via Linux

[alberto743]

As stated in openjournals/joss-reviews#7398, the documentation is shipped as Windows CHM files.
The installation procedure on Linux does not mention the need of having Wine installed.
This should be specified in the README.

[florianober]

The error was already addressed in 1336069. I updated the README in ca49923.
These fixes will be merged to the main branch with the next version.

[alberto743]

Thank you. It would be fine.
Anyhow, by looking more in detail at the issue and potential solutions, it seems to me that a more user-friendly methodology may be employed.
In fact, CHM files are basically a Windows proprietary format that stores several HTML files into a binary archive.
Apparently, it would be possible to extract the HTML by means of something like extract_chmLib on Linux or hh.exe -decompile extracted on Windows.
Since wine is a very big dependency that may pose several side issues, I suggest to evaluate to simply extract the HTML included in the CHM and let the Linux version call an ordinary browser to read the online help.

[florianober]

In fact, at the moment the complete documentation is in one word file and is converted to html and finally to the chm file.
This has historical reasons and as I said, we are working on a better approach using python-sphinx and I think in the end there will be a chm file, online html and maybe even a pdf file.

[alberto743]

I understand.
Anyhow, for the sake of the paper, I think it would be needed to have a consistent way to access to the documentation. I am not asking to change nothing particular. I am just saying that if your code just opens the html files contained in the chm it would be potentially sufficient for the moment. Going through the wine process is too cumbersome. Of course, I am open to any other consistent solution.
Indeed, according to the review guidelines, the documentation part should clearly state the list of dependencies and ideally handle them with an automated package management solution. Using wine let this procedure very difficult.

[florianober]

we are working on this