# Documentation rendered fine in GitHub but not on juliahub

**URL:** <https://discourse.julialang.org/t/documentation-rendered-fine-in-github-but-not-on-juliahub/107668>\
**Category:** Community\
**Tags:** documentation, documenter, juliahub\
**Created:** [December 15, 2023, 2:26pm UTC](https://discourse.julialang.org/t/documentation-rendered-fine-in-github-but-not-on-juliahub/107668 "2023-12-15T14:26:40Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![sylvaticus](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/sylvaticus/32/203883_2.png) [@sylvaticus](https://discourse.julialang.org/u/sylvaticus)\
**Post date:** [December 15, 2023, 2:26pm UTC](https://discourse.julialang.org/t/documentation-rendered-fine-in-github-but-not-on-juliahub/107668/1 "2023-12-15T14:26:40Z")

</div>

Hello, the documentation of one of my packages ([BetaML](https://github.com/sylvaticus/BetaML.jl)) is rendered fine in GitHub pages, but has several errors in JuliaHub:

 ![image](https://global.discourse-cdn.com/julialang/original/3X/0/c/0c76b942b63aee9876633ef2230fb21acded3e82.png)

What could be the cause ?

(I would also have another question, why to replicate documentation pages, but then I would break the rule “1 question 1 thread”)

---

<div class="post-metadata">

**Author:** ![mbauman](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mbauman/32/31082_2.png) [@mbauman](https://discourse.julialang.org/u/mbauman)\
**Post date:** [December 15, 2023, 2:52pm UTC](https://discourse.julialang.org/t/documentation-rendered-fine-in-github-but-not-on-juliahub/107668/2 "2023-12-15T14:52:27Z")

</div>

In general, you can find the logs from documentation generation on the JuliaHub info [page for the package](https://juliahub.com/ui/Packages/General/BetaML) behind that circled ⓘ. I’m not 100% sure what went wrong in this case, but I think it might be a version mismatch between Julia and/or the packages that are installed as you build the docs — I think your GitHub docs builder uses Julia v1.6 whereas JuliaHub is using v1.9.

In any case, if you host your own docs, you can opt out of the documentation building by telling DocumentationGenerator where your docs are — and @pfitzseb [just did that](https://github.com/JuliaDocs/DocumentationGeneratorRegistry/commit/b7cc8524804f971f2412a07ef344369a62a0a0f5)! That gets a bit at the goal here: it’s really useful to be able to know where all the docs are for multiple reasons (including: ecosystem search, a theoretical `@ref` macro here, ability to get docs offline, etc.), and while there are a number of significant improvements needed (and planned!) for JuliaHub’s doc generation.

---

<div class="post-metadata">

**Author:** ![sylvaticus](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/sylvaticus/32/203883_2.png) [@sylvaticus](https://discourse.julialang.org/u/sylvaticus)\
**Post date:** [December 15, 2023, 3:09pm UTC](https://discourse.julialang.org/t/documentation-rendered-fine-in-github-but-not-on-juliahub/107668/3 "2023-12-15T15:09:00Z")

</div>

Thank you, I wasn’t aware of the [DocumentationGeneratorRegistry](https://github.com/JuliaDocs/DocumentationGeneratorRegistry/tree/master).

There are very few packages explicitly defined there… perhaps Julia/JuliaHub could use some “default” rules:  
e.g. for a package registered on `https://github.com/[user]/[pkgName].jl` and not defined in the `DocumentationGeneratorRegistry` check if the url `https://[user].github.io/[pkgName].jl` exists…

---

<div class="post-metadata">

**Author:** ![sylvaticus](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/sylvaticus/32/203883_2.png) [@sylvaticus](https://discourse.julialang.org/u/sylvaticus)\
**Post date:** [December 15, 2023, 3:12pm UTC](https://discourse.julialang.org/t/documentation-rendered-fine-in-github-but-not-on-juliahub/107668/4 "2023-12-15T15:12:01Z")

</div>

By the way, is there any sort order in that registry or one can add the package[s] at the end ?

---

<div class="post-metadata">

**Author:** ![mbauman](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mbauman/32/31082_2.png) [@mbauman](https://discourse.julialang.org/u/mbauman)\
**Post date:** [December 15, 2023, 4:02pm UTC](https://discourse.julialang.org/t/documentation-rendered-fine-in-github-but-not-on-juliahub/107668/5 "2023-12-15T16:02:01Z")

</div>

The order is whatever TOML serializes — easiest/fastest/best way to do it is with the [`add_to_registry.jl`](https://github.com/JuliaDocs/DocumentationGeneratorRegistry/blob/master/add_to_registry.jl) script.