Support dirtyreload so that only updated files get rebuilt

[athackst]

Co-authored-by: @jkaye2012

Closes #441

[jkaye2012]

Hey there - just had a chance to give this a try this morning. Unfortunately from what I'm seeing, I think all files may still be getting rebuilt (or perhaps I'm misunderstanding how this is meant to work).

Running the first time, I see this as expected:

WARNING  -  A 'dirty' build is being performed, this will likely lead to inaccurate navigation and other links within your site. This option is designed for site
            development purposes only.
INFO     -  Documentation built in 121.27 seconds
INFO     -  [15:28:56] Watching paths for changes: '/tmp/mkdocs_simple_repoo60u600b', 'mkdocs.yml', '_doc', 'README.md',
            'bt/analytics/flink/examples/how_to_run_beginner_flink_jobs.md', 'bt/analytics/flink/examples/how_to_run_custom_metrics_job.md',
... many more paths

I can then browse docs as usual.

Upon changing a file, I see this:

INFO     -  Building documentation...
WARNING  -  Config value 'dev_addr': The use of the IP address '0.0.0.0' suggests a production environment or the use of a proxy to connect to the MkDocs server.
            However, the MkDocs' server is intended for local development purposes only. Please use a third party production-ready server instead.
INFO     -  mkdocs-simple-plugin: build_docs_dir: /tmp/mkdocs_simple_repob26prgbu
root dir: /repo/, src dir: /repo/.

But the build doesn't appear to proceed and the site ends up hung (seemingly permanently).

[jkaye2012]

It did eventually rebuild, but took a very long time. Much longer than I remember from last week!

[athackst]

hmm.. I think I didn't keep the venv ignore setting you had which is probably resulting in your setup not working correctly. I added common folders to .mkdocsignore so that they wouldn't be included in a rebuild.

Try again?

[jkaye2012]

Gave that a try with the same result. The test I'm running for this is on our production repository using a system-level installation of the plugin, so I don't think any of the in-repo files here would have an effect. The list of files that the plugin says it's watching seems to be correct so far as I can tell (our repo is quite large, so it's hard to be sure, but I haven't noticed anything that seems off).

I'm going to give this another try a bit later after tossing a few prints in so that we can see what's going on. The fact that it takes longer to re-generate than it does to generate from scratch makes me think that there is something "recursive" going on, so it's also very possible that this is an issue with the way that I have things set up. Will report back!

[jkaye2012]

Facepalm. I cloned the repo and installed it locally, but didn't check out the feature branch before doing so 🤦

Everything seems to be working perfectly, sorry about that!

[jkaye2012]

I'm going to close #442 in lieu of this

[athackst]

Cool! Good to here. I'll merge in then 😄

[jkaye2012]

Awesome! Is there anywhere I can follow to see when this makes it into a release?

[athackst]

You can go to watch -> custom -> releases on the repo and you should get an alert when the next release is made 🚀