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.

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

Include a simple config for the polarion plugin #2750

Merged
merged 1 commit into from
Mar 11, 2024
Merged

Conversation

psss
Copy link
Collaborator

@psss psss commented Mar 8, 2024

So far the Pylero documentation was only mentioned in examples. Let's make it easier to get started by providing a simple config.

Pull Request Checklist

  • write the documentation

@psss
Copy link
Collaborator Author

psss commented Mar 8, 2024

@happz, originally I was thinking about including the example and link directly in the plugin but including the anonymous rst link in the plugin docstring caused the following error:

  File "/home/psss/.local/share/hatch/env/virtual/tmt/v_yBwOy-/docs/lib/python3.12/site-packages/docutils/nodes.py", line 2033, in dispatch_visit
    return method(node)
           ^^^^^^^^^^^^
  File "/home/psss/git/tmt/tmt/utils.py", line 6959, in unknown_visit
    raise GeneralError(f"Unhandled ReST node '{node}'.")
tmt.utils.GeneralError: Unhandled ReST node '<target anonymous="1" ids="['target-1']" refuri="https://github.com/RedHatQE/pylero"/>'.

Seems to be related to our custom parsing in the tmt.utils.parse_rst() function. Could you possibly look into that?

@psss psss added documentation Improvements or additions to documentation step | report Stuff related to the report step plugin | polarion Plugins implementing the Polarion integration labels Mar 8, 2024
@happz
Copy link
Collaborator

happz commented Mar 8, 2024

@happz, originally I was thinking about including the example and link directly in the plugin but including the anonymous rst link in the plugin docstring caused the following error:
...
Seems to be related to our custom parsing in the tmt.utils.parse_rst() function. Could you possibly look into that?

Sure, it's far from complete (and perfect). I'll add a unit test for it, and implement link rendering in the process.

@psss psss added the command | export The export command label Mar 11, 2024
So far the Pylero documentation was only mentioned in examples.
Let's make it easier to get started by providing a simple config.
@psss psss self-assigned this Mar 11, 2024
@psss psss added this to the 1.32 milestone Mar 11, 2024
@psss psss merged commit 8b92b29 into main Mar 11, 2024
14 of 22 checks passed
@psss psss deleted the pylero-quick-start branch March 11, 2024 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command | export The export command documentation Improvements or additions to documentation plugin | polarion Plugins implementing the Polarion integration step | report Stuff related to the report step
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants