useblocks / sphinx-bazel

Sphinx extension to read bazel files
http://sphinx-bazel.readthedocs.io/en/latest/
Apache License 2.0
11 stars 4 forks source link

how to run this as a py_binary target #20

Closed dzheng256 closed 4 years ago

dzheng256 commented 4 years ago

Is it possible to run sphinx as a py_binary target and have it use sphinx-bazel via bazel run //doc:run_sphinx_bazel ? It seems that in its current state, to use sphinx-bazel one needs to run sphinx via its cli outside of the bazel environment?

Also i'm not sure i follow the docs at https://sphinx-bazel.readthedocs.io/en/latest/quickstart.html#document-bazel.

It says "Where must be an absolute path or a relative path to the location of the conf.py file of your documentation project." however you created the project via sphinx-quickstart, presumably outside of the bazel workspace? is path_to_bazel_workspace supposed to be the full path to the bazel workspace? or is it to the conf.py outside the bazel workspace?