Skip to content

Fixes read the docs #381

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Dec 7, 2024
Merged

Conversation

mcbarton
Copy link
Collaborator

@mcbarton mcbarton commented Dec 6, 2024

Description

Please include a summary of changes, motivation and context for this PR.

@vgvassilev This PR will fix the read the docs giving us the developer documentation again. The other day I was fixing the deployment blind as I didn't know about the build logs. Here it is for the most recent build https://readthedocs.org/projects/cppinterop/builds/26507232/ . By expanding the python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html command you see we fail due to the following error

CMake Error at CMakeLists.txt:238 (message):
  We need either USE_CLING or USE_REPL

This PR will fix that by defining that we want to use the repl when building the docs. The build logs explain why we still get some of the documentation, see

writing output... [ 14%] DevelopersDocumentation
writing output... [ 29%] FAQ
writing output... [ 43%] InstallationAndUsage
writing output... [ 57%] UsingCppInterOp
writing output... [ 71%] index
writing output... [ 86%] reference
writing output... [100%] tutorials

Fixes # (issue)

Type of change

Please tick all options which are relevant.

  • Bug fix
  • New feature
  • Requires documentation updates

Testing

Please describe the test(s) that you added and ran to verify your changes.

Checklist

  • I have read the contribution guide recently

Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.15%. Comparing base (1c3f884) to head (ab20320).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #381   +/-   ##
=======================================
  Coverage   76.15%   76.15%           
=======================================
  Files           8        8           
  Lines        3137     3137           
=======================================
  Hits         2389     2389           
  Misses        748      748           

@mcbarton mcbarton merged commit f1391cd into compiler-research:main Dec 7, 2024
42 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants