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

Fix MkDocs build #539

Merged

Conversation

smokestacklightnin
Copy link
Contributor

@smokestacklightnin smokestacklightnin commented Jan 15, 2025

Partially addresses #529

This PR solves build failures on Read The Docs by telling git to ignore files that mkdocs/read the docs changes.

This PR does not solve the underlying issue with non-editable installs.

Preview the successfully built docs here

@smokestacklightnin smokestacklightnin force-pushed the packaging/fix/editable-install branch from 980155e to 25ff4e4 Compare January 15, 2025 02:12
@smokestacklightnin
Copy link
Contributor Author

smokestacklightnin commented Jan 15, 2025

Avoiding a dirty index seems to solve the timestamp problem when installing on RTD.

Now I'm getting a very strange error:

WARNING - mkdocs_autorefs: generated/tutorials/gallery_python_api.md: Could not find cross-reference target 'ragna.source_storages.Qdrant'

The line originally read ragna.source_storages.QdrantDB, but fixing it to ragna.source_storages.Qdrant still gives the same error.

Will continue to investigate

Update: I figured it out. "Qdrant" was missing from __all__

@smokestacklightnin smokestacklightnin changed the title Fix non-editable install Fix MkDocs build Jan 15, 2025
@smokestacklightnin smokestacklightnin marked this pull request as ready for review January 15, 2025 02:47
Copy link
Member

@pmeier pmeier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks William, way better fix that what I suggested in #529 (comment). We have a mkdocs hook that shows the files and the respective diff that originates from RTD. However, that relies on git to figure out the changes, which are no longer reported when we --assume-unchanged. Could you add a post_install RTD hook that effectively does git update-index --really-refresh?

.readthedocs.yml Outdated Show resolved Hide resolved
.readthedocs.yml Outdated Show resolved Hide resolved
smokestacklightnin added a commit to smokestacklightnin/ragna that referenced this pull request Jan 15, 2025
@smokestacklightnin smokestacklightnin force-pushed the packaging/fix/editable-install branch from dafa120 to 4c71146 Compare January 15, 2025 20:46
@smokestacklightnin smokestacklightnin force-pushed the packaging/fix/editable-install branch 2 times, most recently from f33f2aa to 1ce849e Compare January 16, 2025 04:46
@smokestacklightnin smokestacklightnin force-pushed the packaging/fix/editable-install branch from 14a6bd7 to b30177c Compare January 16, 2025 05:44
@pmeier pmeier merged commit dca421b into Quansight:main Jan 16, 2025
10 checks passed
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

Successfully merging this pull request may close these issues.

2 participants