Skip to content

Doc: migrate engine pages from ewoks.esrf.fr#320

Merged
loichuder merged 1 commit into
mainfrom
add-engine-pages
Jul 3, 2026
Merged

Doc: migrate engine pages from ewoks.esrf.fr#320
loichuder merged 1 commit into
mainfrom
add-engine-pages

Conversation

@loichuder

@loichuder loichuder commented Jul 3, 2026

Copy link
Copy Markdown
Member

https://ewoks.esrf.fr/en/latest/engines.html is too technical for a PR website. I migrate it to the doc of ewoks by splitting it in two pages:

  • engines.rst: the top part that compares engines
  • new_engine.rst: the last section that explains how to add a specific engine. It may be extended now that it is a separate page.

Since the number of how-to guides become quite large, I reorganized the table of contents into several sections. If we agree on this during the review, I can also reorganize the file themselves (which I didn't do here to avoid a large changelog).

Again, Claude did the conversion to RST and I proof-read it.

Comment thread doc/howtoguides.rst

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Image


Some engines support more advanced features, like loops or GUI interaction:

.. raw:: html

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The table was a bit painful to migrate. Rather than doing a mix-and-match of RST and HTML, I preferred to use HTML all the way.

@loichuder loichuder requested a review from a team July 3, 2026 10:10
Comment thread doc/howtoguides/engines.rst Outdated
Comment thread doc/howtoguides/new_engine.rst Outdated
Comment thread doc/howtoguides/new_engine.rst Outdated
@loichuder loichuder merged commit 3d8b702 into main Jul 3, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants