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

Docs compilation error #24

Open
lpawela opened this issue Oct 29, 2020 · 10 comments
Open

Docs compilation error #24

lpawela opened this issue Oct 29, 2020 · 10 comments

Comments

@lpawela
Copy link

lpawela commented Oct 29, 2020

When trying to compile the documentation (numericalshadow/numericalshadow.org@90c5d5c) I get an error

ERROR: LoadError: MethodError: no method matching header_level(::BibInternal.Entry)
Closest candidates are:
  header_level(::Markdown.Header{N}) where N at /home/lpawela/.julia/packages/Documenter/WSKVc/src/Utilities/Utilities.jl:315
Stacktrace:
 [1] populate!(::Documenter.Documents.ContentsNode, ::Documenter.Documents.Document) at /home/lpawela/.julia/packages/Documenter/WSKVc/src/Documents.jl:428
 [2] populate!(::Documenter.Documents.Document) at /home/lpawela/.julia/packages/Documenter/WSKVc/src/Documents.jl:390
 [3] runner(::Type{Documenter.Builder.Populate}, ::Documenter.Documents.Document) at /home/lpawela/.julia/packages/Documenter/WSKVc/src/Builder.jl:235
 [4] dispatch(::Type{Documenter.Builder.DocumentPipeline}, ::Documenter.Documents.Document) at /home/lpawela/.julia/packages/Documenter/WSKVc/src/Utilities/Selectors.jl:167
 [5] #2 at /home/lpawela/.julia/packages/Documenter/WSKVc/src/Documenter.jl:240 [inlined]
 [6] cd(::Documenter.var"#2#3"{Documenter.Documents.Document}, ::String) at ./file.jl:104
 [7] #makedocs#1 at /home/lpawela/.julia/packages/Documenter/WSKVc/src/Documenter.jl:239 [inlined]
 [8] top-level scope at /home/lpawela/new-zksi-repo/numericalshadow.org/make.jl:95
 [9] include(::Function, ::Module, ::String) at ./Base.jl:380
 [10] include(::Module, ::String) at ./Base.jl:368
 [11] exec_options(::Base.JLOptions) at ./client.jl:296
 [12] _start() at ./client.jl:506
in expression starting at /home/lpawela/new-zksi-repo/numericalshadow.org/make.jl:95

Without DocumenterCitations everwything works. Am I doing something wrong?

@ali-ramadhan
Copy link
Owner

Ah can't say I've seen this error before. Thanks for reporting @lpawela.

Looks like you're doing the same thing as the docs here so I don't see why it wouldn't work: https://github.com/ali-ramadhan/DocumenterCitations.jl/blob/master/docs/src/references.md

Out of curiousity what version of Documenter.jl are you using?

@ali-ramadhan
Copy link
Owner

@lpawela
Copy link
Author

lpawela commented Oct 29, 2020

Yes, it works, but gives warnings

[ Info: Expanding citation: gallay2010the.
┌ Warning: reference for 'gallay2010the' could not be found in src/numerical-shadow.md.
└ @ DocumenterCitations ~/.julia/packages/DocumenterCitations/Kqcie/src/citations.jl:50

As for the version

(@v1.5) pkg> st
  [e30172f5] Documenter v0.25.0 `https://github.com/JuliaDocs/Documenter.jl.git#v0.25.0`
  [daee34ce] DocumenterCitations v0.1.0

@ali-ramadhan
Copy link
Owner

Ah from looking at numericalshadow/numericalshadow.org@fa9d0aa I think you deleted the

```@bibliography
```

block so yeah the references won't be found. Does it work if you just remove the # Literature header and leave the @bibliography block intact?

One thing to also try is to upgrade to the latest version of Documenter.jl (v0.25.3) and maybe try the latest version of DocumenterCitations.jl (via ] add DocumenterCitations#master for now).

@lpawela
Copy link
Author

lpawela commented Oct 30, 2020

The error is still present with

[e30172f5] Documenter v0.25.3
[daee34ce] DocumenterCitations v0.1.0 `https://github.com/ali-ramadhan/DocumenterCitations.jl.git#master`

@pnavaro
Copy link

pnavaro commented Nov 21, 2020

I have the same error. I had to remove the @contents Documenter macro to make things work.

@guilgautier
Copy link

As proposed in #33, you can simply

Remove the file where the @bibliography block is called, from the list of Pages involved in all @contents block.

In your case, you may consider

  • removing "litterature.md" from the list of Pages in the @context block of your src/index.md file
    @contents
    Pages = ["numerical-range.md", "numerical-shadow.md", "numerical-range/calculate.md", "software.md",
    "literature.md",
    "acknowledgements.md", "contact.md"]
    Depth = 2

  • and add back the @bibliography block in your src/litterature.md file as in numericalshadow/numericalshadow.org@90c5d5c

@cmichelenstrofer
Copy link

Had the same error. Removing the @contents worked.

@goerz
Copy link

goerz commented Jul 13, 2023

Please check if this is still a problem with the newly released DocumenterCitations.jl v1.0. If so, can you open a new issue at https://github.com/JuliaDocs/DocumenterCitations.jl/issues?

@goerz
Copy link

goerz commented Jul 13, 2023

It's still a problem, now tracked at JuliaDocs/DocumenterCitations.jl#16

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

6 participants