# Docs formatting on Galaxy

**URL:** <https://forum.ansible.com/t/docs-formatting-on-galaxy/11253>\
**Category:** Project Discussions\
**Tags:** vmware, galaxy, galaxy-ng\
**Created:** [December 1, 2024, 2:59pm UTC](https://forum.ansible.com/t/docs-formatting-on-galaxy/11253 "2024-12-01T14:59:21Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [December 1, 2024, 2:59pm UTC](https://forum.ansible.com/t/docs-formatting-on-galaxy/11253/1 "2024-12-01T14:59:21Z")

</div>

Galaxy shows collection documentation. I think this has started somewhere during the last months, although I can’t find the announcement anymore.

Whatever, if you look at e.g. [vmware\_cluster\_drs](https://galaxy.ansible.com/ui/repo/published/community/vmware/content/module/vmware_cluster_drs/?version=5.1.0) you’ll see `L(new vmware.vmware collection,http://forum.ansible.com/t/5880)` and `M(vmware.vmware.cluster_drs)`.

Shouldn’t this be formatted as links like [here](https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_cluster_drs_module.html)?

Sorry if this has been asked already, but I wasn’t able to find anything about this either here or on GitHub.

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [December 1, 2024, 3:22pm UTC](https://forum.ansible.com/t/docs-formatting-on-galaxy/11253/2 "2024-12-01T15:22:19Z")

</div>

> [@mariolenz](#):
>
> Galaxy shows collection documentation. I think this has started somewhere during the last months, although I can’t find the announcement anymore.

It started with the switch to galaxy\_ng, i.e. roughly one year ago 🙂

> [@mariolenz](#):
>
> Whatever, if you look at e.g. [vmware\_cluster\_drs](https://galaxy.ansible.com/ui/repo/published/community/vmware/content/module/vmware_cluster_drs/?version=5.1.0) you’ll see `L(new vmware.vmware collection,http://forum.ansible.com/t/5880)` and `M(vmware.vmware.cluster_drs)`.
> 
> Shouldn’t this be formatted as links like [here](https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_cluster_drs_module.html)?

Yes. I guess it’s a bug that in these parts Ansible markup is not formatted.

The corresponding code is here: [ansible-hub-ui/src/components/render-plugin-doc/render-plugin-doc.tsx at master · felixfontein/ansible-hub-ui · GitHub](https://github.com/felixfontein/ansible-hub-ui/blob/master/src/components/render-plugin-doc/render-plugin-doc.tsx#L415-L425) Applying `this.applyDocFormatters()` to `doc.deprecated.why` and `doc.deprecated.alternative` should fix this.

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [December 1, 2024, 4:06pm UTC](https://forum.ansible.com/t/docs-formatting-on-galaxy/11253/3 "2024-12-01T16:06:26Z")

</div>

Thanks @felixfontein! I’ve opened [this issue](https://github.com/ansible/ansible-hub-ui/issues/5328) and mentioned your suggestion there.

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [February 28, 2025, 5:38pm UTC](https://forum.ansible.com/t/docs-formatting-on-galaxy/11253/4 "2025-02-28T17:38:14Z")

</div>

There might be another formatting / rendering problem.

We’ve had an [issue](https://github.com/ansible-collections/community.vmware/issues/2336) recently in `community.vmware`. The problem is that `default_gateway` is a sub-option of `network`, but it doesn’t show up on [galaxy](https://galaxy.ansible.com/ui/repo/published/community/vmware/content/module/vmware_vmkernel/?version=5.4.0) that way. It looks OK on [docs.ansible.com](https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_vmkernel_module.html#ansible-collections-community-vmware-vmware-vmkernel-module), though.

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [February 28, 2025, 8:52pm UTC](https://forum.ansible.com/t/docs-formatting-on-galaxy/11253/5 "2025-02-28T20:52:03Z")

</div>

> [@mariolenz](#):
>
> `default_gateway`

That’s already fixed by [Fix zero width of spacer columns indenting suboptions and sub-return values by felixfontein · Pull Request #5417 · ansible/ansible-hub-ui · GitHub](https://github.com/ansible/ansible-hub-ui/pull/5417), merged two days ago. I have no idea when this will end up on [galaxy.ansible.com](http://galaxy.ansible.com) though…

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [March 2, 2025, 12:06pm UTC](https://forum.ansible.com/t/docs-formatting-on-galaxy/11253/6 "2025-03-02T12:06:24Z")

</div>

@felixfontein FYI it looks like your changes show up on galaxy now 😃

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [March 2, 2025, 12:56pm UTC](https://forum.ansible.com/t/docs-formatting-on-galaxy/11253/7 "2025-03-02T12:56:01Z")

</div>

Hmm, looks like the zero width fix didn’t work fully: [Ansible Galaxy](https://galaxy.ansible.com/ui/repo/published/community/crypto/content/module/acme_account_info/#return-values)

Adding `min-width: 20px` to the `spacer` definition fixes it for me.

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [March 2, 2025, 1:01pm UTC](https://forum.ansible.com/t/docs-formatting-on-galaxy/11253/8 "2025-03-02T13:01:54Z")

</div>

> <https://github.com/ansible/ansible-hub-ui/pull/5454>
>
> It seems that #5417 was not sufficient in some cases.
> 
> 1. \`default\_gateway\` in… https://galaxy.ansible.com/ui/repo/published/community/vmware/content/module/vmware\_vmkernel/?version=5.4.0 is now correctly indented.
> 2. \`authorizations \` in https://galaxy.ansible.com/ui/repo/published/community/crypto/content/module/acme\_account\_info/#return-values is not correctly indented (but note that its field \`identifiers\` is indented).
> 
> For me, adding an additional \`min-width: 20px\` to \`.spacer\` fixed the problem. I've tested this both with current Firefox and Chromium.
