search

elixir-cldr / cldr_units

Unit formatting (volume, area, length, ...) functions for the Common Locale Data Repository (CLDR)
Other
16 stars 13 forks source link

Docs are broken / Update to ex_doc 0.31 #42

Closed nTraum closed 3 months ago

nTraum commented 3 months ago

Hello,

many thanks for this great library first of all! :)

The docs on https://hexdocs.pm/ex_cldr_units/readme.html are currently broken, most notably the sidebar navigation.

image

When pulling latest main (53cd06b074367763bffac8939ee6f40ce9b6fc00) and building the docs locally via mix docs, they look fine. I wonder if the docs were built on ex_doc v0.30.8 or earlier, because v0.30.9 mentions in the changelog:

Bug fixes

Fix a scenario where invalid assets would be generated

https://github.com/elixir-lang/ex_doc/blob/main/CHANGELOG.md#v0309-2023-10-20

Not sure if that is the root cause though, I didn't investigate further what 'invalid assets' exactly are, but it could be the culprit.

kipcole9 commented 3 months ago

Philip, thanks for the issue and the kind words. I will fix the docs - I suspect I need to clean out the docs directory and rebuild them (there were some changes in ex_doc that were intolerant of existing docs).

I do like this library but ... the Cldr.Units.Math module is a complete mess and doesn't work correctly at all. I am going to extract that to its own library and publish an update to ex_cldr_units on April 17th aligned to the release of CLDR 45. I am working hard to get the Math module working as it should but it will take longer than a week.

I'll get the docs fixed in the next hour or so.

kipcole9 commented 3 months ago

I've cleaned and regenerated the docs and published to hex. They seem ok to me now - let me know if you see otherwise.

I'll close the PR but I do appreciate the contribution - I've updated all the deps to latest release before I generated the docs again.

nTraum commented 3 months ago

That was ridiculously fast, I can confirm that the docs are looking fine now.

Thank you for your work, appreciate it! :bow: