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

DOC: Add Read the Docs config file #720

Merged
merged 21 commits into from
Jul 7, 2022
Merged

DOC: Add Read the Docs config file #720

merged 21 commits into from
Jul 7, 2022

Conversation

fepegar
Copy link
Contributor

@fepegar fepegar commented Apr 26, 2022

The Read the Docs (RTD) build is failing as requirements cannot be imported: https://readthedocs.org/projects/inereye-deeplearning/builds/16688167/

In this PR, an RTD config file is added that specifies the path to the requirements file needed for building.

If it works, it will resolve #706.

@fepegar fepegar changed the title Add Read the Docs config file DOC: Add Read the Docs config file Apr 26, 2022
@fepegar
Copy link
Contributor Author

fepegar commented Apr 26, 2022

The requirements added in b8af514 are for the documentation itself, but we still need to tell RTD where to look for the requirements needed for the package itself. We can probably get inspiration from https://github.com/microsoft/hi-ml.

@fepegar fepegar marked this pull request as draft April 26, 2022 18:46
@fepegar
Copy link
Contributor Author

fepegar commented Apr 27, 2022

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@peterhessey peterhessey self-assigned this May 19, 2022
@peterhessey peterhessey added documentation Improvements or additions to documentation bug Something isn't working deployment Work to enable/improve model deployment labels May 19, 2022
@fepegar
Copy link
Contributor Author

fepegar commented Jun 6, 2022

Thanks for looking into this, @peterhessey. I'm so looking forward to having nice docs for IE and HIML!

@fepegar fepegar self-assigned this Jun 22, 2022
@fepegar fepegar marked this pull request as ready for review July 7, 2022 11:02
@fepegar fepegar requested a review from peterhessey July 7, 2022 14:55
@fepegar fepegar enabled auto-merge (squash) July 7, 2022 14:55
Copy link
Contributor

@peterhessey peterhessey left a comment

Choose a reason for hiding this comment

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

Amazing code, the best, probably the best in the world, definitely the biggest.

image

@fepegar fepegar merged commit 88a805e into main Jul 7, 2022
@fepegar fepegar deleted the 706-add-rtd-config branch July 7, 2022 15:06
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working deployment Work to enable/improve model deployment documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Documentation hosting
3 participants