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

Formatting broken #1873

Open
Divelix opened this issue Nov 8, 2023 · 1 comment
Open

Formatting broken #1873

Divelix opened this issue Nov 8, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Divelix
Copy link

Divelix commented Nov 8, 2023

Configuration File Reference page formatting in docs seems broken.
Link: https://cyclonedds.io/docs/cyclonedds/latest/config/config_file_reference.html

@eboasson
Copy link
Contributor

While I don't quite know what it is that you consider broken, I do agree it is not quite right, e.g.:

image

that definitely looks like it was meant to be formatted like <a href="https://cyclonedds.io/docs/cyclonedds/latest/config/config_file_reference.html#cyclonedds-domain-id">Id</a>. The code in

fprintf(out, "%s[%s](", sep, name(ce));
printlink(out, level, flags, ce, units);
fprintf(out, ")");
produces a proper link in Markdown, so I wonder what tool messed it up in generating HTML 🤔

image

definitely looks like it was meant to be a bulleted list of two items, that would be _confgen I assume;

image

and arguably the size of the umpteenth-level header used for the name doesn't sit nicely with the size of the body text ...

There are also some other things, but I think all of these issues are cosmetic and won't make pose a problem for anyone. So given how far I'm behind on support fixing this isn't the top priority ...

Thanks a lot for pointing it out!

@eboasson eboasson added good first issue Good for newcomers documentation Improvements or additions to documentation labels Nov 28, 2023
ThijsSassen added a commit to ThijsSassen/cyclonedds that referenced this issue Nov 29, 2023
eboasson pushed a commit that referenced this issue Nov 29, 2023
* Fix for #1873 to generate proper rst links for attributes

* Added missing API documentation

* Update of hashes for generated config options files

* Updated documentation on configuring shared memory to fix #1883

* Updated wrongly formatted refs and missing group refs in documentation headers

* Made links better readable
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants