search

sphinx-doc / sphinx-autobuild

Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a hot-reload web server.
MIT License
524 stars 75 forks source link

Autoreload on code changes #31

Closed jacobsvante closed 9 years ago

jacobsvante commented 9 years ago

First of all, thanks for a great project.

One thing that would be awesome is if sphinx-autobuild . _build/html could also include checking if code has been updated for my project. Right now the autodoc parts of my documentation is not reflected when the docstrings change in the code. What do you think? Would this be possible to implement?

GaretJax commented 9 years ago

Hi Jacob, this should already be implemented, you have to manually add the directory to watch using the correct flag.

Best,Jonathan

Apologies for any cryptic brevity or errors; this message was composed on a mobile device.

On Thu, Jun 11, 2015 at 8:05 PM, Jacob Magnusson notifications@github.com wrote:

First of all, thanks for a great project.

One thing that would be awesome is if sphinx-autobuild . _build/html could also include checking if code has been updated for my project. Right now the autodoc parts of my documentation is not reflected when the docstrings change in the code. What do you think? Would this be possible to implement?

Reply to this email directly or view it on GitHub: https://github.com/GaretJax/sphinx-autobuild/issues/31

jacobsvante commented 9 years ago

Indeed it did. Can't help but feel a bit stupid. Thanks!

GaretJax commented 9 years ago

No problem. Have fun using the tool. :-)

jacobsvante commented 9 years ago

Thanks!

I wonder though.. Why doesn't it also build the code when starting up? Having to run sphinx-build before with basically the same arguments feels a bit "pancake on pancake" like we say in Sweden :smile:

GaretJax commented 9 years ago

I don't get the question. Could you show me what you're trying to achieve?

Best,Jonathan

Apologies for any cryptic brevity or errors; this message was composed on a mobile device.

On Fri, Jun 12, 2015 at 1:49 AM, Jacob Magnusson notifications@github.com wrote:

Thanks!

I wonder though.. Why doesn't it also build the code when starting up? Having to run sphinx-build before with basically the same arguments feels a bit "pancake on pancake" like we say in Sweden :smile:

Reply to this email directly or view it on GitHub: https://github.com/GaretJax/sphinx-autobuild/issues/31#issuecomment-111308424

jacobsvante commented 9 years ago 
$ cd docs
$ rm -rf _build
$ sphinx-autobuild -z ../flask_resize . _build/html
[I 150612 01:52:21 server:271] Serving on http://127.0.0.1:8000
[I 150612 01:52:21 handlers:58] Start watching changes
[I 150612 01:52:21 handlers:60] Start detecting changes

It doesn't build the docs.

Instead I have to do:

$ cd docs
$ rm -rf _build
$ sphinx-build . _build/html
Running Sphinx v1.3.1
making output directory...
loading pickled environment... not yet created
[...]
$ sphinx-autobuild -z ../flask_resize . _build/html
[I 150612 01:52:21 server:271] Serving on http://127.0.0.1:8000
[I 150612 01:52:21 handlers:58] Start watching changes
[I 150612 01:52:21 handlers:60] Start detecting changes
GaretJax commented 9 years ago

Oh, now I got it. Sorry it's late.

You're right, that could be useful and would also be easy to implement. Feel free to open an issue for that (or a PR :-).

jacobsvante commented 9 years ago

Might do it when I get some more spare time... What do you think, should the docs be re-built by default?

GaretJax commented 9 years ago

Yes, I would do it by default, with a switch to turn it off.

rouge8 commented 8 years ago

@GaretJax this doesn't seem to work for me? When I save, it triggers the rebuild as expected, but the built content is not actually changed.

Command: 

sphinx-autobuild -E -a -z /Users/rouge8/rj/fathom-assets/fathom_assets -n -b html -d /Users/rouge8/rj/fathom-assets/.tox/docs-dev/tmp/doctrees . _build/html

Output:

+--------- ../fathom_assets/query/managers.py changed ---------------------------
| Running Sphinx v1.3.1
| loading intersphinx inventory from https://docs.python.org/2.7/objects.inv...
| building [mo]: all of 0 po files
| building [html]: all source files
| updating environment: 3 added, 0 changed, 0 removed
| reading sources... [ 33%] api
| reading sources... [ 66%] index
| reading sources... [100%] queries
|
| looking for now-outdated files... none found
| pickling environment... done
| checking consistency... done
| preparing documents... done
| writing output... [ 33%] api
| writing output... [ 66%] index
| writing output... [100%] queries
|
| generating indices... genindex py-modindex
| highlighting module code... [ 25%] fathom_assets.query.managers
| highlighting module code... [ 50%] fathom_assets.query.terms
| highlighting module code... [ 75%] fathom_assets.query.query
| highlighting module code... [100%] fathom_assets.query.nodes
|
| writing additional pages... search
| copying static files... done
| copying extra files... done
| dumping search index in English (code: en) ... done
| dumping object inventory... done
| build succeeded.
+--------------------------------------------------------------------------------

+--------- ../fathom_assets/query/managers.py changed ---------------------------
| Running Sphinx v1.3.1
| loading intersphinx inventory from https://docs.python.org/2.7/objects.inv...
| building [mo]: all of 0 po files
| building [html]: all source files
| updating environment: 3 added, 0 changed, 0 removed
| reading sources... [ 33%] api
| reading sources... [ 66%] index
| reading sources... [100%] queries
|
| looking for now-outdated files... none found
| pickling environment... done
| checking consistency... done
| preparing documents... done
| writing output... [ 33%] api
| writing output... [ 66%] index
| writing output... [100%] queries
|
| generating indices... genindex py-modindex
| highlighting module code... [ 25%] fathom_assets.query.managers
| highlighting module code... [ 50%] fathom_assets.query.terms
| highlighting module code... [ 75%] fathom_assets.query.query
| highlighting module code... [100%] fathom_assets.query.nodes
|
| writing additional pages... search
| copying static files... done
| copying extra files... done
| dumping search index in English (code: en) ... done
| dumping object inventory... done
| build succeeded.
+--------------------------------------------------------------------------------

[I 150904 01:55:34 handlers:91] Reload 1 waiters: None
[I 150904 01:55:34 handlers:131] Browser Connected: http://127.0.0.1:8000/api.html#module-fathom_assets.query.managers