Skip to content
This repository has been archived by the owner on Sep 19, 2021. It is now read-only.

[RFC] Generate user documentation. #5

Merged
merged 1 commit into from
Sep 21, 2014
Merged

Conversation

fwalch
Copy link
Member

@fwalch fwalch commented Jul 30, 2014

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 fwalch changed the title Generate user documentation. [WIP] Generate user documentation. Jul 30, 2014
@fwalch fwalch changed the title [WIP] Generate user documentation. [RFC] Generate user documentation. Jul 30, 2014
@fwalch
Copy link
Member Author

fwalch commented Jul 30, 2014

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

@justinmk
Copy link
Member

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
Copy link
Member Author

fwalch commented Jul 30, 2014

@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
Copy link
Member Author

fwalch commented Jul 30, 2014

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
Copy link
Member

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

@fwalch
Copy link
Member Author

fwalch commented Aug 18, 2014

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

Updated to resolve merge conflicts.

@fwalch fwalch changed the title [RFC] Generate user documentation. [WIP] Generate user documentation. Aug 22, 2014
@fwalch fwalch mentioned this pull request Aug 22, 2014
26 tasks
@fwalch fwalch force-pushed the user-docu branch 2 times, most recently from d4c1220 to fbfcd26 Compare September 13, 2014 19:07
@fwalch
Copy link
Member Author

fwalch commented Sep 13, 2014

Rebased from master. Build, Output

}

# Helper function to extract inline JavaScript from HTML head
# Extract inline JavaScript from HTML file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@justinmk
Copy link
Member

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

@fwalch
Copy link
Member Author

fwalch commented Sep 13, 2014

I guess this still needs neovim/neovim#1011?

Yup.

@fwalch fwalch changed the title [WIP] Generate user documentation. [RFC] Generate user documentation. Sep 21, 2014
@fwalch
Copy link
Member Author

fwalch commented Sep 21, 2014

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

Build, Output

justinmk added a commit that referenced this pull request Sep 21, 2014
Generate user documentation.
@justinmk justinmk merged commit b166362 into neovim:master Sep 21, 2014
@justinmk
Copy link
Member

Yay!

@fwalch fwalch deleted the user-docu branch September 21, 2014 16:09
@tarruda
Copy link
Member

tarruda commented Sep 22, 2014

Looking good :)

@justinmk
Copy link
Member

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
Copy link
Member Author

fwalch commented Sep 22, 2014

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants