Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

[BBS-282] [BBS-241] Update docs + Upload on RTD #266

Merged
merged 13 commits into from
Mar 8, 2021
Merged

Conversation

FrancescoCasalegno
Copy link
Contributor

@FrancescoCasalegno FrancescoCasalegno commented Mar 5, 2021

Fixes BBS-282, BBS-241.

Description

This PR makes our code ready for uploading on RTD.

  1. Add info on installing with PyPI (i.e. pip install bluesearch) to the documentation and README.md.
  2. Add a .readthedocs.yml configuration file for RTD.
  3. Drop mysqlclient dependency (used only for mysqldb fast connections in our src code) if building on RTD. The rationale for this is as follows.
    1. mysqlclient needs the C library libmysqlclient-dev to be installed (see here)
    2. RTD does not allow to install C libraries (see here) and even though 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).
    3. Luckily we do not importthe mysqldb 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 the docs.
  4. Important the stable build of RTD is failing. This is because the git commit we tagged with v0.1.0 still had mysqlclient 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

  • This PR refers to an issue from the issue tracker.
    (if it is not the case, please create an issue first).
  • Documentation and whatsnew.rst updated.
    (if needed)
  • setup.py and requirements.txt updated with new dependencies.
    (if needed)
  • All CI tests pass.

@FrancescoCasalegno FrancescoCasalegno marked this pull request as ready for review March 5, 2021 16:58
@FrancescoCasalegno FrancescoCasalegno changed the title [BBS-282] Upload docs on RTD [BBS-282] [BBS-241] Upload docs on RTD Mar 5, 2021
@FrancescoCasalegno FrancescoCasalegno changed the title [BBS-282] [BBS-241] Upload docs on RTD [BBS-282] [BBS-241] Update docs + Upload on RTD Mar 5, 2021
Copy link
Contributor

@jankrepl jankrepl left a 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.

Copy link
Contributor

@EmilieDel EmilieDel left a 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!

Copy link
Contributor

@Stannislav Stannislav left a comment

Choose a reason for hiding this comment

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

Looking good, thanks!

@FrancescoCasalegno FrancescoCasalegno merged commit 6901a43 into master Mar 8, 2021
@FrancescoCasalegno FrancescoCasalegno deleted the bbs_282 branch March 8, 2021 15:59
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants