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

ReadTheDocs configuration file (v2) #485

Merged
merged 4 commits into from
Dec 4, 2020
Merged

ReadTheDocs configuration file (v2) #485

merged 4 commits into from
Dec 4, 2020

Conversation

CasperWA
Copy link
Member

@CasperWA CasperWA commented Sep 4, 2020

Close #452

Move to ReadTheDocs. This PR adds a configuration file for it.

@CasperWA CasperWA added the docs Issues pertaining to documentation. label Sep 4, 2020
@codecov
Copy link

codecov bot commented Sep 4, 2020

Codecov Report

Merging #485 (bca0ab1) into master (da20c54) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #485   +/-   ##
=======================================
  Coverage   92.20%   92.20%           
=======================================
  Files          61       61           
  Lines        3246     3246           
=======================================
  Hits         2993     2993           
  Misses        253      253           
Flag Coverage Δ
project 92.20% <ø> (ø)
validator 65.89% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update da20c54...bca0ab1. Read the comment docs.

@ml-evs
Copy link
Member

ml-evs commented Nov 26, 2020

What was the decision about whether we should go ahead with this @CasperWA? Could we enable it for this PR and see how well it works?

Pros:

  • versioned docs
  • doc previews on PR builds

Cons:

  • Ads (fairly unobtrusive)
  • Slightly less/more convoluted control over builds
  • I don't think we'll get docs for older versions, unless we add the readthedocs config file and retag (disabling our PyPI release beforehand)

@ml-evs
Copy link
Member

ml-evs commented Nov 26, 2020

Could we enable it for this PR and see how well it works?

Just found that its already enabled (but not showing up in GitHub status checks), but the build is failing...

@ml-evs
Copy link
Member

ml-evs commented Nov 26, 2020

Could we enable it for this PR and see how well it works?

Just found that its already enabled (but not showing up in GitHub status checks), but the build is failing...

The PR build itself is fine, so it should work in master too. I'm happy to merge this so we can evaluate both options "live", then eventually sunset the mkdocs/pages build and switch the URL over to readthedocs. Your call @CasperWA.

@CasperWA CasperWA marked this pull request as ready for review December 4, 2020 18:10
@CasperWA CasperWA merged commit 1ffb03d into master Dec 4, 2020
@CasperWA CasperWA deleted the close_452_add-rtd branch December 4, 2020 18:32
@ml-evs
Copy link
Member

ml-evs commented Dec 4, 2020

Hmmm, master builds are still failing even after merging, due to an API reference error. I'll try to fix this before 0.12.5, otherwise we won't get any 0.12.x docs versions up.

Scratch that, stable != master 🤦

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues pertaining to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Frequency of updating online docs
2 participants