This repository has been archived by the owner on Jan 29, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
[BBS-282] [BBS-241] Update docs + Upload on RTD #266
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FrancescoCasalegno
changed the title
[BBS-282] Upload docs on RTD
[BBS-282] [BBS-241] Upload docs on RTD
Mar 5, 2021
FrancescoCasalegno
changed the title
[BBS-282] [BBS-241] Upload docs on RTD
[BBS-282] [BBS-241] Update docs + Upload on RTD
Mar 5, 2021
FrancescoCasalegno
requested review from
pafonta,
jankrepl,
Stannislav and
EmilieDel
March 5, 2021 17:33
jankrepl
approved these changes
Mar 8, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Thanks for this PR.
EmilieDel
approved these changes
Mar 8, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM ! Thanks for the PR and the explanation!
Stannislav
approved these changes
Mar 8, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good, thanks!
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes BBS-282, BBS-241.
Description
This PR makes our code ready for uploading on RTD.
pip install bluesearch
) to the documentation andREADME.md
..readthedocs.yml
configuration file for RTD.mysqlclient
dependency (used only formysqldb
fast connections in our src code) if building on RTD. The rationale for this is as follows.mysqlclient
needs the C librarylibmysqlclient-dev
to be installed (see here)libmysqlclient-dev
should be installed in the Docker image of RTD (see here) there is an known bug that makes this library unavailable (see here).import
themysqldb
module anywhere in our code (it is only used for establishing efficient connections to the MySQL servers) so we can drop it from our dependencies if we just need to build thedocs
.stable
build of RTD is failing. This is because the git commit we tagged withv0.1.0
still hadmysqlclient
as a dependency. For this reason, as this PR gets merged, we should then move the tag to this commit (I know, it's awful).How to test?
Builds are passing and you can see the docs on RTD here.
Checklist
(if it is not the case, please create an issue first).
whatsnew.rst
updated.(if needed)
setup.py
andrequirements.txt
updated with new dependencies.(if needed)