[WIP] Add initial new docs

[Blendify]

This converts all the html documentation into restructured text files.

TODO:

• Fix compile warnings
• Finalize on doc structure
• update menu.xml
• modify the theme to remove sidebar for local docs?
• set up translations
• add python tools
• some css fixes

[fcomida]

We still need html for HelpBrowser, in my understanging one can convert from reStructuredText to many other formats, can you expand on this?

[Blendify]

Yes, you can use Sphinx http://www.sphinx-doc.org/en/stable/ to convert to html

I have not been able to use the help browser (it crashes) but I think we can take the reStructuredText docs compile them to html during normal compilation instead of keeping html files in the repo.

[fcomida]

I'll merge this when you automate the process then ;)

[Blendify]

BTW is there a Linux download somewhere? My distro does not have the package.

[fcomida]

Which distro? A generic linux package is virtually impossible to build. Snap? Flatpack? Those could be a possibility....any volunteer?

[Blendify]

I am using Elementary OS (a modified Ubuntu)

[fcomida]

I have elementaryOS on a VM, I'm gonna try to compile LHDR on it, it will need the qtwebkit patch I suppose since it's based on ubuntu 16.04 if I well remember. There is an ubuntu ppa out there, you could try it.

[fcomida]

I had to install gnome-icon-theme and set XDG_CURRENT_DESKTOP=GNOME in order to display all the icons...

[Blendify]

That is fine do you happen to have the build somewhere? I have still not been able to compile myself and as I said the windows (2.5.0) build crashes when trying open up the local help. So testing is a little hard for me right now. I guess my main question is does the html view work well with complex HTML? I see right now the html files are very basic. The sphinx_rtd_theme is much more advanced so not sure if it will work. On the other hand I can either make a custom super basic theme for use with the local docs or use the built in basic theme. Again here is the current docs: http://luminancehdr.readthedocs.io/en/latest/

[fcomida]

I'll upload the two binaries later on, the installation root is /usr/local so you must create luminance-hdr directory under /usr/local/share and copy hdrhtml and help in /usr/local/share/luminance-hdr. Put the binaries in /usr/local/bin
HelpBrowser uses QtWebEngine i.e. Chromium so I guess it can handle complex HTML, some distros like elementaryOS don't ship QtWebEngine so I created a patch that reverts to QtWebKit i.e. Safari so again no problem with complex HTML.

[fcomida]

[fcomida]

This one is more fun.

[fcomida]

elementaryOS binaries

[Blendify]

I think this is good enough to be merged. There are still some todos but all the docs are converted.

To test:

• Install python (I use python3)
• install pypi packages: pip install -r docs/requirements.txt
• run the make file or compile source: docs/make html

[fcomida]

Thanks a lot, I'm reviewing it, some changes are still needed, there are flaws here and there (missing or misnamed images), some part of the documentation is really outdated (the FAQ for instance). A great job overall!!! By my side I need to change HelpBrowser a bit; since the TOC and Search features are now directly into the HTML the sidebar isn't needed anymore, I have to think how to handle bookmarks....
Have you tried my elementaryOS binaries? I posted the link above.

[Blendify]

Do not worry a lot about the changes this was mainly to convert the existing over to RST.
Mainly make sure I did not miss anything (like the images).
I would like help to make sure I did the cmake stuff correctly, I am still rather new to cmake.

some part of the documentation is really outdated (the FAQ for instance).

We can handle stuff like this later.

By my side I need to change HelpBrowser a bit; since the TOC and Search features are now directly into the HTML the sidebar isn't needed anymore, I have to think how to handle bookmarks....

I can also probally for the local docs remove the sidebar with some css tricks.
I can also add a feature to the theme directly to not include the sidebar.

Have you tried my elementaryOS binaries? I posted the link above.

Not yet but will likely test tonight.

[fcomida]

I wanna release 2.5.1 as soon as possible so I guess your work will go into 2.5.2. I like the sidebar in HTML, one problem I found is "printing":


Is there a way to generate a simpler HTML for printing (or something, some css trick, I don't know)?

[Blendify]

I do not think so

[fcomida]

Hello, I added a menu entry for opening the documentetion online with the desktop system browser. It points of course at luminancehdr.readthedocs.io