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

Crinja documentation isn't viewable #14

Open
devnote-dev opened this issue Oct 16, 2024 · 6 comments
Open

Crinja documentation isn't viewable #14

devnote-dev opened this issue Oct 16, 2024 · 6 comments

Comments

@devnote-dev
Copy link

Crystaldoc says straight-shoota/crinja is already imported, but it doesn't show up in the search and isn't available by manually constructing the doc URL.

@nobodywasishere
Copy link
Owner

This happens when the docs fail to build, I'll investigate why these ones failed

@straight-shoota
Copy link

straight-shoota commented Nov 21, 2024

Is there a way to access the doc generator's log output for failed jobs?

crinja API docs should not have any special requirements or anything. So I have no clue why it would fail to build.

Btw. API docs are available at https://straight-shoota.github.io/crinja/api/latest/

@nobodywasishere
Copy link
Owner

That's another thing that should be included in the rewrite. I didn't originally due to security concerns but that was a mistake.

I can take a look at crinja docs and see why they failed to build and let you know

@nobodywasishere
Copy link
Owner

Here is the error, can reproduce locally as well

❯ crystal doc                                                                
Showing last frame. Use --error-trace for full trace.

In src/runtime/callable.cr:110:18

 110 | alias Proc = Arguments -> Value
                    ^--------
Error: undefined constant Arguments

@nobodywasishere
Copy link
Owner

Ah it's because you have a specific src/docs.cr that you use for docs. Really wish there was a docs_main or w/e in the shards.yml so that I could just do shards doc and have it choose the right file

@straight-shoota
Copy link

Yeah, I suppose the require order is relevant 😢
make docs is your friend =)

Ideally this should be fixed, though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants