Documentation update for control qubit negation

[schweitzpgi]

For some unknown reason they cause the sphinx builder script to crash and burn.
Docs changes for PR #81.

[schweitzpgi]

@bettinaheim These documentation changes look fairly mundane, but the bots don't like them. I can't figure out why. Can you take a look?

[bettinaheim]

@bettinaheim These documentation changes look fairly mundane, but the bots don't like them. I can't figure out why. Can you take a look?

@schweitzpgi Sure. FYI, in case you haven't seen it, if you go to the CI run, you will see a build folder in the artifacts when the docs generation fails. You can click on it to download it. On one hand that folder contains the log files that are mentioned by the docs generation script, and on the other hand, that folder is what contains the build to reproduce the issue locally.

For this PR, the log shows the following sphinx error:

/workspaces/cuda-quantum/docs/sphinx/specification/cudaq/synthesis.rst:61: ERROR: Error in "code-block" directive:
maximum 1 argument(s) allowed, 5 supplied.

.. code-block:: cpp
   cudaq::control(kernel{}, {qubit0, !qubit1}, kernel_arg);

You are lacking an empty line after code-block. See also https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block

[schweitzpgi]

@bettinaheim These documentation changes look fairly mundane, but the bots don't like them. I can't figure out why. Can you take a look?

@schweitzpgi Sure. FYI, in case you haven't seen it, if you go to the CI run, you will see a build folder in the artifacts when the docs generation fails. You can click on it to download it. On one hand that folder contains the log files that are mentioned by the docs generation script, and on the other hand, that folder is what contains the build to reproduce the issue locally.

For this PR, the log shows the following sphinx error:

/workspaces/cuda-quantum/docs/sphinx/specification/cudaq/synthesis.rst:61: ERROR: Error in "code-block" directive:
maximum 1 argument(s) allowed, 5 supplied.

.. code-block:: cpp
   cudaq::control(kernel{}, {qubit0, !qubit1}, kernel_arg);

You are lacking an empty line after code-block. See also https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block

I did download the zip file, but I found nothing that led me to the problem inside.

[bettinaheim]

@bettinaheim These documentation changes look fairly mundane, but the bots don't like them. I can't figure out why. Can you take a look?

@schweitzpgi Sure. FYI, in case you haven't seen it, if you go to the CI run, you will see a build folder in the artifacts when the docs generation fails. You can click on it to download it. On one hand that folder contains the log files that are mentioned by the docs generation script, and on the other hand, that folder is what contains the build to reproduce the issue locally.
For this PR, the log shows the following sphinx error:

/workspaces/cuda-quantum/docs/sphinx/specification/cudaq/synthesis.rst:61: ERROR: Error in "code-block" directive:
maximum 1 argument(s) allowed, 5 supplied.

.. code-block:: cpp
   cudaq::control(kernel{}, {qubit0, !qubit1}, kernel_arg);

You are lacking an empty line after code-block. See also https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block

I did download the zip file, but I found nothing that led me to the problem inside.

If you look at the failing step, it tells you

Sphinx exit code: 1
Documentation generation failed with exit code 12.
Check the logs in /workspaces/cuda-quantum/build/logs, and the documentation build output in /workspaces/cuda-quantum/build/docs

The build folder dumped as artifact is this /workspaces/cuda-quantum/build folder. The error message I posted above is in the logs/sphinx_error.txt file.