cylc / cylc-doc

Documentation (User Guide, Cheat Sheets, etc.) for the Cylc Workflow Engine.
https://cylc.github.io/cylc-doc/
GNU General Public License v3.0
9 stars 19 forks source link

cylc hub: document multi-user config post jupyter server v2 upgrade #625

Closed oliver-sanders closed 10 months ago

oliver-sanders commented 12 months ago

Requirements check-list

MetRonnie commented 10 months ago

Exception during build worked around by https://github.com/cylc/cylc-doc/pull/636 (though build still fails on that PR without the changes from this one I think)

oliver-sanders commented 10 months ago

(rebased)

oliver-sanders commented 10 months ago

(rebased)

oliver-sanders commented 10 months ago

CI is failing with:

Exception occurred:
  File "/opt/hostedtoolcache/Python/3.9.17/x64/lib/python3.9/site-packages/hieroglyph/builder.py", line 135, in post_process_images
    if node['uri'].startswith(self.outdir):

This error is coming from make slides and is caused by a lack of Sphinx 7 support in hieroglyph. Basically we jumped the gun with Sphinx 7 but the tests didn't appear to fail at the time?

MetRonnie commented 10 months ago

Basically we jumped the gun with Sphinx 7 but the tests didn't appear to fail at the time?

I think the problem is we're peeling back the lid on multiple failures but only one at a time. Unfortunately I didn't think to test the slides locally

oliver-sanders commented 10 months ago

I've removed slides from the standard list of CI builds, with #640 to track re-adding this when hieroglyph is fixed.

The alternative would be to revert recent Sphinx 7 fixes and roll back to Sphinx 6. Given we're not actively using the slides I think we may as well drop them for now.

oliver-sanders commented 10 months ago

Sphinx version has now been rolled back to <7 for 8.2.x (still >7.1 for 8.3.x)

MetRonnie commented 10 months ago

Need this to work in Sphinx <7.2 (which Tim spotted in https://github.com/cylc/cylc-flow/pull/5710)

diff --git a/src/user-guide/task-implementation/job-scripts.rst b/src/user-guide/task-implementation/job-scripts.rst
index a6d74a26..a5ba61d8 100644
--- a/src/user-guide/task-implementation/job-scripts.rst
+++ b/src/user-guide/task-implementation/job-scripts.rst
@@ -186,5 +186,5 @@ Task messages are validated by:

 .. autoclass:: cylc.flow.unicode_rules.TaskMessageValidator
-   :no-index:
+   :noindex:

 Aborting Job Scripts on Error
oliver-sanders commented 10 months ago

Does that need to be cherry-picked back?

https://github.com/cylc/cylc-flow/pull/5710#issuecomment-1714152645

oliver-sanders commented 10 months ago

Merged 8.2.x PR and kicked CI here.

oliver-sanders commented 10 months ago

:crossed_fingers: should pass this time...