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.

Sign up for GitHub

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

Jump to bottom

Q: how to avoid to generate entries point to not exists file. #113

Closed
tshu-w opened this issue Aug 2, 2022 · 8 comments
Closed

Q: how to avoid to generate entries point to not exists file. #113

tshu-w opened this issue Aug 2, 2022 · 8 comments

Comments

@tshu-w
Copy link

tshu-w commented Aug 2, 2022

Hi, I'm trying to use doc2dash to generate scikit-learn doc for dash Kapeli/Dash-User-Contributions#3805 Kapeli/Dash-User-Contributions#3812. However, the ci complains about File not found:

Scikit/scikit-learn.tgz: FAIL ❌
File not found at "genindex.html" for entry with row id "3058" of "scikit-learn.docset"
File not found at "py-modindex.html" for entry with row id "3222" of "scikit-learn.docset"
File not found at "py-modindex.html" for entry with row id "3327" of "scikit-learn.docset"
[NOTICE] Some pages loaded online resources, which might mean the docset doesn't work offline.

I am asking for advice on how to solve this problem, here are the commands I tried:

# download scikit-learn docs directly
wget https://scikit-learn.org/stable/_downloads/scikit-learn-docs.zip
unzip -d scikit-learn-docs scikit-learn-docs.zip

# convert to dash
doc2dash --index-page documentation.html --enable-js -n scikit-learn scikit-learn-docs
tar --exclude='.DS_Store' -czvf scikit-learn.tgz scikit-learn.docset
@hynek
Copy link
Owner

hynek commented Aug 2, 2022

Unfortunately downloading built docs from ReadTheDocs etc doesn't work for the reasons you're saying. For some reason it's missing files.

You have to download the repo and build the docs yourself. :(

@tshu-w
Copy link
Author

tshu-w commented Aug 2, 2022

Yes, so I also tried to build the docs myself in this PR but also facing this issue: https://github.com/tshu-w/Dash-User-Contributions/blob/0efe2f5ef9aa3b05f39e1fc2d474b4df2ea8c880/docsets/Scikit/build.sh#L37-L47

@hynek
Copy link
Owner

hynek commented Sep 4, 2022

I'm sorry, but I don't see an issue?

@tshu-w
Copy link
Author

tshu-w commented Sep 5, 2022

Hi, my question is that in this PR, even if I build the docs myself, github-actions still complain about file not found. It would be much appreciated if you could help to check where the problem is.

@hynek
Copy link
Owner

hynek commented Sep 5, 2022

I see!

This is probably related to #115, but I guess I'll have to fix it broader.

I believe I've fixed it in c3593ac – any chance you could try it out? I'm not sure when I'll be able to push out a new release. :-/

@tshu-w
Copy link
Author

tshu-w commented Sep 6, 2022

Hi @hynek, It works now Kapeli/Dash-User-Contributions#3871! Thank you for your efforts.

@tshu-w tshu-w closed this as completed Sep 6, 2022
@hynek
Copy link
Owner

hynek commented Sep 6, 2022

Great, happy to see scikit-learn docsets!

@hynek
Copy link
Owner

hynek commented Sep 14, 2022

JFTR, I've released doc2dash 3 yesterday, so please use the PyPI version again...I can't guarantee the main branch to remain stable and it could break your builds.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hynek @tshu-w