-
Type:
Task
-
Resolution: Fixed
-
Priority:
Unknown
-
Affects Version/s: None
-
Component/s: None
-
None
-
None
-
None
-
None
-
None
-
None
-
None
-
None
Context
We can use sphinx-autobuild to build our docs live, reducing the reliance on an RST preview feature in an IDE, that may or may not support the plugins that we are using.
The tox config would look something like:
[testenv:doc-serve]
description = serve sphinx docs
deps =
{[testenv:doc]deps}
sphinx-autobuild
commands =
sphinx-autobuild -E -W -b html doc --watch ./pymongo --watch ./bson --watch ./gridfs ./doc/_build/serve
Definition of done
We should add the above tox target, and update the contributing docs for live testing, and also a link to https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html.
Pitfalls
N/A