Is there a particular reason why when I search the docs for seeing where a file it is defined in, I am getting a 404?

[UltimaTerra]

Hi, I am trying to make a GUI game engine with Crystal, and I wanted to use this library for GTK bindings. I am not trying to make an efficient 2-D/3-D engine, just one that works with simple design. I was browsing the docs for seeing where what is defined where and a lot come up with 404. I was wondering if it was normal: https://hugopl.github.io/gtk4.cr/

Thank you, otherwise keep up the great work! I love the idea of this project, regardless if I use GTK for my Game Engine.

[hugopl]

Hi, it's a known issue.

The API is generated from source files generated by the binding generator, so they aren't on github. If you look at the links you will see things like:

https://github.com/hugopl/gtk4.cr/blob/729b9a3ea5294ad559b0647e8850c43dbee6fe58/lib/gi-crystal/src/auto/g_object-2.0/object.cr#L250

Everything inside lib/gi-crystal/src/auto is generated.

A solution would be to git add the generated files in the gh-pages repository and maybe play with crysal doc options like --source-url-pattern and --canonical-base-url.

I would love to have this fixed but I probably wont be fixing that. The reason is simple: lack of time, so I prefer to use my limited time to work on bug fixes despite of the importance of having good docs.

If you are interested in fix that the docs are generated by this github action: https://github.com/hugopl/gtk4.cr/blob/main/.github/workflows/gh-pages.yml it just call make doc, you can find what it does by looking at https://github.com/hugopl/gtk4.cr/blob/main/Makefile

[UltimaTerra]

Hi, so I did that I think. I cloned the repo in vs code (I used solarized light mode because I code at night, fair warning). Here is my output.
I did this because I noticed the github workflows uses the same Ubuntu as I use, I am just on Pop OS. I generated the docs without a problem I believe, but here is my full output. BUT, as far as I can tell, the docs generated just fine.

I am inclined to believe it might be an issue with the github action, but I would be lying if I said I knew what was going on, I will try to see if I can make the github action to work on my end. Any other troubleshooting steps I should take?

Also, If I can make it work, I assume I can just submit a pull request with the changes?

Edit: Docs generated with the make command, but if you try to open the html in the browser, it does get a 404 again. I guess that is expected, I am going to do some troubleshooting best as I can.

[hugopl]

Yes, a PR is welcome.