Automatically refresh documentation when using `mkdocs serve`

[d0ugal]

This would make the eediting experience really neat. @ericholscher had an idea for a GUI app that could do this, but this approach might be enough.

One possible approach - inject some JavaScript that either polls or uses web sockets to be notified of an update.

[ericholscher]

sphinx-autobuild does this with websockets. It's pretty nifty.

On Fri, Oct 17, 2014 at 3:45 AM, Dougal Matthews notifications@github.com
wrote:

This would make the eediting experience really neat. @ericholscher
https://github.com/ericholscher had an idea for a GUI app that could do
this, but this approach might be enough.

One possible approach - inject some JavaScript that either polls or uses
web sockets to be notified of an update.

—
Reply to this email directly or view it on GitHub
#163.

Eric Holscher
Maker of the internet residing in Portland, Or
http://ericholscher.com

[ngzhian]

looks like sphinx-autobuild uses python-livereload, which in turn relies on livereload.
I tried my hands on livereload, pretty cool and it works simply from the command line (you need to install the extension for your browser first though)
Looking at the way sphinx-autobuild does it scares me a little. I went ahead to look at the source of python-livereload and figured that for our use case, it is a simple case of serving out of our temp build directory.
This was problematic due to an issue, details here, hopefully that is resolved soon and I will have a PR for this.

[ngzhian]

The author of python-livereload has confirmed that this is a bug, and proceeded to fix it up really quickly. The fix will propagate to pypi in a couple of days.

[lepture]

BTW. python-livereload has a built-in static server.

It would be a little off topic, maybe you will be interested in https://github.com/lepture/mistune. It is the fastest markdown parser in pure Python.

[d0ugal]

Intresting, I'll check out livereload but I really don't like the idea of requiring a plugin. I can't see why that is needed?

@lepture thanks, speed isn't an issue for us at the moment. It is interesting to know alternatives are available. Thankfully docs building doesn't need to scale far ;)

[lepture]

@d0ugal You don't need a plugin. This python-livereload will inject the javascript automatically.

[d0ugal]

Oh, sorry, I must have totally missread something. I can't even see where I got that from :) So yeah, we should totally look into trying that out. I'll have a go with it. Thanks.