Documenter.jl: BibTeX references

Created on 16 Dec 2016  路  6Comments  路  Source: JuliaDocs/Documenter.jl

Is it possible to include citations to papers following a syntax similar to BibTeX where we have a file with all rereferences bibliography.bib and cite specific ones in the documentation with \cite,\citep,... variants?

Most helpful comment

All 6 comments

Changes such as these would need to be added to the markdown parser in Base.Markdown. Nothing can be done in Documenter to add \cite etc syntax to the parser. I'm not sure it's a good idea to start extending the parser with LaTeX-isms, is there any alternative syntax we could borrow (perhaps from pandoc) that would be sufficient for this?

Thank you @MichaelHatherly , I was just curious if that was something doable and worth doing. I believe it is not according to your comment. I will close the issue but let me know if you have an idea on how to incorporate references to articles in the documentation.

I was trying to use the syntax

[<label>](@ref)

where <label> is the label attached to the item in a bibtex file. I am using pybtex for parsing the bib file.

In the makedocs you can specify an array of bibtex files.

makedocs(
    ....
    bibtex = [ "/home/luciano/SomeFile.bib"]
)

and then when every search of the <label> reference was failed It search on the bib file.
But then I got lost using anchors and links. For now only prints the title. will try again soon.

I would also be interested in incorporating some packages to be able to cite things in the documentation.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

haampie picture haampie  路  3Comments

halirutan picture halirutan  路  4Comments

mforets picture mforets  路  3Comments

asinghvi17 picture asinghvi17  路  3Comments

SimonEnsemble picture SimonEnsemble  路  3Comments