[RFC] Generate user documentation.

[fwalch]

With neovim/neovim#1011, HTML user documentation can be generated. If the build passes, the user docu should show up at https://fwalch.github.io/doc/user.

I used a similar approach to the clang report to wrap the docu in Neovim's layout. Unfortunately, the contents of eval.html (9000 lines or so?) were too much for envsubst, so I had to modify generate_report to echo the body directly.

[fwalch]

The docu built successfully, although there was a warning regarding sed flags. Should be fixed now.

[justinmk]

That looks great.

I noticed a bug: go to http://fwalch.github.io/doc/user/intro.html and click on an option link (eg 'compatible'). It is not linked correctly, it just goes to http://fwalch.github.io/doc/user/options.html#

This bug doesn't happen on http://vimhelp.appspot.com/ so perhaps we should use that python script (source here: https://github.com/c4rlo/vimhelp )

[fwalch]

@justinmk That bug was actually not the script's fault, but mine. I initially thought that the envsubst problem was caused by quoting issues, so I performed a search-and-replace that ultimately destroyed some links. I removed this (helper functions are now the same as in master, only case-insensitive); all links should now work correctly. A build is currently running.

[fwalch]

Added another commit that replaces color="PURPLE" with the "Neovim green", but that's only a hack until the awk script is replaced with something that outputs CSS-stylable HTML (neovim/neovim.github.io#55 (comment)).

[justinmk]

@fwalch Didn't realize you had fixed the bug. Think this is RDY?

[fwalch]

@justinmk neovim/neovim#1011 will need to be merged first, otherwise I'd say yes.

Updated to resolve merge conflicts.

[fwalch]

Rebased from master. Build, Output

[justinmk]

👍

[justinmk]

I guess this still needs neovim/neovim/pull/1011 ?

[fwalch]

I guess this still needs neovim/neovim#1011?

Yup.

[fwalch]

Now that neovim/neovim#1011 is in master, this should be ready.

Build, Output

[justinmk]

Yay!

[tarruda]

Looking good :)

[justinmk]

user-docu build failed :

From git://github.com/neovim/doc
 * branch            gh-pages   -> FETCH_HEAD
error: Sparse checkout leaves no entry on working directory

[fwalch]

Sorry for that; the subtree (sparse) checkout doesn't work if there is no actual subdirectory. See neovim/doc#2.