pcdshub / pytmc

Generate EPICS IOCs and records from TwinCAT projects - along with many TwinCAT project tools
https://pcdshub.github.io/pytmc/
Other
10 stars 11 forks source link

DOC: fix docs build CI #315

Closed ZLLentz closed 1 year ago

ZLLentz commented 1 year ago

closes #312 if the docs build CI passes

klauer commented 1 year ago

Some unrelated docs things to fix at some point:

/home/runner/work/pytmc/pytmc/docs/source/release_notes.rst:46: ERROR: Unexpected indentation.
/home/runner/work/pytmc/pytmc/docs/source/release_notes.rst:49: WARNING: Block quote ends without a blank line; unexpected unindent.
ZLLentz commented 1 year ago

One more curveball: does the sphinx pin belong in ci helpers instead, since I think lots of repos will have this problem?

tangkong commented 1 year ago

What were the actual details of the sphinx error? I assumed it was specific to this repo but I would believe it's more widespread.

ZLLentz commented 1 year ago

tl;dr there is no sphinx-rtd-theme released with full sphinx 7 compatibility

ZLLentz commented 1 year ago

closing and reopening to refresh the ci without adding a commit

ZLLentz commented 1 year ago

I think this is nearly in its final form There's still a pin added to the requirements file, but it's a > pin for sphinx_rtd_theme to prevent the older build with no knowledge about sphinx pinning from being installed This hopefully means that it will switch to sphinx 7 seamlessly when it is supported (or, alternatively it will break again) Unfortunately I think this still means that every repo needs to add the same pin?

CI is still pointing to the other branch

ZLLentz commented 1 year ago

This seems like it may be fully done pending CI

klauer commented 1 year ago

Looks good to me 👍