mozilla / sphinx-js

Autodoc-style extraction into Sphinx for your JS project
https://pypi.python.org/pypi/sphinx-js/
MIT License
282 stars 81 forks source link

the docs cannot be host in ReadTheDocs #187

Open LinkunGao opened 2 years ago

LinkunGao commented 2 years ago

Hi, Currently, I use sphinx-js everything works good in local, but I meet a big issue is that I cannot host my documentation on Readthedocs. I did the same config as mentioned in the sphinx-js readme, but the readthedocs always say an error that " Sphinx error: jsdoc found no JS files in the directories ['/home/docs/checkouts/readthedocs.org/user_builds/readthedoc-test-l/checkouts/latest/myproject']. Make sure js_source_path is set correctly in conf.py. It is also possible (though unlikely) that jsdoc emitted invalid JSON. " the screenshot for the error: image

In my project, I stored the js file in myproject folder and I did jsdoc config like this: image here is the shinpx-js config: .readthedocs.yml image requierments.txt

Everything is the same as the sphinx-js readme and everything work perfectly on local.

Can anyone help me host documentation on Readthedocs by using sphinx-js? or is there any examples that can host documentation on Readthedocs?

here is my repository for testing sphinx-js host on readthedocs : https://github.com/LinkunGao/readthedoc-test-l

Thanks!

phfaist commented 1 year ago

For what it's worth, I got the docs for my project hosted on readthedocs without any issue. I'm using poetry, but I'm not sure if that makes a big difference. See https://zoodb.readthedocs.org/ & https://github.com/phfaist/zoodb