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.

Sign up for GitHub

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

Jump to bottom

adding RTD conf file V2 as per request #983

Merged
merged 5 commits into from
Sep 18, 2023
Merged

adding RTD conf file V2 as per request #983

merged 5 commits into from
Sep 18, 2023

Conversation

esc
Copy link
Member

@esc esc commented Aug 15, 2023

As title

@esc esc mentioned this pull request Aug 15, 2023
Closed
@esc
Copy link
Member Author

esc commented Aug 15, 2023

This is failing now, even though I added a .readthdocs.yaml file as appropriate.

Screen Shot 2023-08-15 at 14 59 10

@esc esc mentioned this pull request Sep 18, 2023
Merged
jezdez
jezdez reviewed Sep 18, 2023
View reviewed changes
.readthedocs.yml Outdated
version: 2

build:
os: ubuntu-22.04
Copy link

Choose a reason for hiding this comment

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

Suggested change
os: ubuntu-22.04
os: "ubuntu-22.04"

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think that is the problem. The string ubuntu-22.04 is also listed w/o quotes here:

https://docs.readthedocs.io/en/stable/config-file/v2.html

Copy link
Member Author

Choose a reason for hiding this comment

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

Also, https://www.yamllint.com/ claims the .readthedocs.yaml files is indeed valid YAML.

Copy link

Choose a reason for hiding this comment

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

Just noting that it DOES work for https://github.com/conda/conda-build/pull/5006/files#diff-cde814ef2f549dc093f5b8fc533b7e8f47e7b32a8081e0760e57d5c25a1139d9R4

Copy link

Choose a reason for hiding this comment

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

(could also just be an unrelated state issue since you're adding the file completely new)

@esc esc force-pushed the rtd_conf_v_2 branch 2 times, most recently from 764f65d to 6f18ddf Compare September 18, 2023 11:21
@esc
Copy link
Member Author

esc commented Sep 18, 2023

After removal of the old readthedocs.yaml file (without the . prefix) I now get:

Processing /home/docs/checkouts/readthedocs.org/user_builds/llvmlite/checkouts/983
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'error'
  error: subprocess-exited-with-error
  
  × python setup.py egg_info did not run successfully.
  │ exit code: 1
  ╰─> [1 lines of output]
      setup.py disabled on readthedocs: called with ['/home/docs/checkouts/readthedocs.org/user_builds/llvmlite/checkouts/983/setup.py', 'egg_info', '--egg-base', '/tmp/pip-pip-egg-info-bp1l4alb']
      [end of output]
  
  note: This error originates from a subprocess, and is likely not a problem with pip.
error: metadata-generation-failed

× Encountered error while generating package metadata.
╰─> See above for output.

note: This is an issue with the package mentioned above, not pip.
hint: See above for details.

@esc esc force-pushed the rtd_conf_v_2 branch 3 times, most recently from bc0c49b to ca6e44b Compare September 18, 2023 12:04
@esc
manually set the RTD theme
ee1f5ef 
As of configuration file V2 for Read The Docs (RTD) the
`sphinx-rtd-theme` is no longer injected automagically by RTD. So we can
do away with all the redundant configuration and checking if we are on
RTD or not. The is now a single way to build documentation, on RTD or
locally.
@esc esc changed the base branch from release0.41 to main September 18, 2023 12:17
@esc
Copy link
Member Author

esc commented Sep 18, 2023

Notes for reviewers:

  • check correct theme on local and RTD builds
  • check string last updated.. is injected correctly in both environments
  • overall sanity checks and look for more opportunities to remove legacy

@esc esc added this to the v0.41.0-final milestone Sep 18, 2023
sklam
sklam approved these changes Sep 18, 2023
View reviewed changes
Copy link
Member

@sklam sklam left a comment

Choose a reason for hiding this comment

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

The doc rendering checks out.

docs/environment.yml
- python=3.9
- sphinx
# https://stackoverflow.com/questions/67542699/readthedocs-sphinx-not-rendering-bullet-list-from-rst-fileA
- docutils==0.16
Copy link
Member

Choose a reason for hiding this comment

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

checked bullet list renders correctly.

@esc esc merged commit b0bb788 into numba:main Sep 18, 2023
@esc esc deleted the rtd_conf_v_2 branch September 19, 2023 10:13
esc added a commit to esc/llvmlite that referenced this pull request Sep 19, 2023
@esc
Merge pull request numba#983 from esc/rtd_conf_v_2
54aa676 
adding RTD conf file V2 as per request
esc added a commit to esc/llvmlite that referenced this pull request Sep 19, 2023
@esc
update CHANGE_LOG to include numba#983 and numba#985
218bf29 
As title
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jezdez jezdez jezdez left review comments

@sklam sklam sklam approved these changes

Assignees
No one assigned
Labels
5 - Ready to merge
Projects
None yet
Milestone
v0.41.0-final
Development

Successfully merging this pull request may close these issues.
3 participants
@esc @jezdez @sklam