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

When outputting to Markdown, characters are converted to HTML variant #32

Open
JulioPDX opened this issue Feb 26, 2024 · 1 comment
Open

Comments

@JulioPDX
Copy link

For example, we have the python docstring below,

description: |-
  The `arista.avd.deploy_to_cv` module is an Ansible Action Plugin providing the following capabilities:

  - Verify Devices are in the CloudVision inventory.
  - Verify Devices are in the Inventory & Topology Studio.
  - Update the Device hostname in the Inventory & Topology Studio as needed.
  - Create Workspace and build, submit, abandon as needed.
  - Deploy EOS configurations using "Static Configlet Studio".

The characters like &, <, and > are converted to HTML. Like below

The `arista.avd.deploy_to_cv` module is an Ansible Action Plugin providing the following capabilities:

- Verify Devices are in the CloudVision inventory.
- Verify Devices are in the Inventory &amp; Topology Studio.
- Update the Device hostname in the Inventory &amp; Topology Studio as needed.
- Create Workspace and build, submit, abandon as needed.
- Deploy EOS configurations using &#34;Static Configlet Studio&#34;.
@juremedvesek
Copy link
Collaborator

Hi can confirm that this is the case. Thinking about resolution:

  1. default MD render should not HTML escape (site-packages/antsibull_docs_parser/md.py, class MDFormatter(Formatter))
  2. introduction of new MD option that is not HTML aware.

Need to oversleep it before implementation

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

No branches or pull requests

2 participants