Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

the docs cannot be host in ReadTheDocs #187

Open
LinkunGao opened this issue Jan 20, 2022 · 1 comment
Open

the docs cannot be host in ReadTheDocs #187

LinkunGao opened this issue Jan 20, 2022 · 1 comment
Milestone

Comments

@LinkunGao
Copy link

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!

@willkg willkg added this to the 3.2 milestone Feb 23, 2022
@willkg willkg modified the milestones: 3.2.0, 3.next Dec 13, 2022
@phfaist
Copy link

phfaist commented Aug 15, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants