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: use DocumenterCitations #326

Merged
merged 3 commits into from
Mar 11, 2021
Merged

Conversation

rfourquet
Copy link
Contributor

DocumenterCitations.jl uses Bibliography.jl to add support for BibTeX citations and references in documentation pages generated by Documenter.jl.

Cf. #311.
This PR adds a dummy reference in a bib file, which is referenced from a docstring or from the documentation in an .md file.
If someone wants to provide a real citation (maybe @wdecker or @GDeFranceschi have one?), I will replace the dummy one.

@GDeFranceschi
Copy link
Contributor

DocumenterCitations.jl uses Bibliography.jl to add support for BibTeX citations and references in documentation pages generated by Documenter.jl.

Cf. #311.
This PR adds a dummy reference in a bib file, which is referenced from a docstring or from the documentation in an .md file.
If someone wants to provide a real citation (maybe @wdecker or @GDeFranceschi have one?), I will replace the dummy one.

A reference I will use for the documentation will surely be:
Taylor, D. E., Pairs of Generators for Matrix Groups. I, The Cayley Bulletin, 3 (1987).
Anyway, I will add most of my references once the branches involving weird algorithms are merged to the master branch.

@fingolfin
Copy link
Member

@GDeFranceschi can you provide a bibtex version of that ref? Alternatively I guess mathscinet can produce bibtex

@GDeFranceschi
Copy link
Contributor

GDeFranceschi commented Mar 10, 2021

I did not find the article on MathSciNet. I produced something like this:

@Article
{Tay87,
author={D. E. Taylor},
title={Pairs of Generators for Matrix Groups. I},
journal={The Cayley Bulletin},
volume={3},
year=1987,
pages={76--85}
}

@rfourquet
Copy link
Contributor Author

I updated by removing the dummy citations, and added the bib entry provided by @GDeFranceschi . Citations can be referenced via something like [Tay87](@cite).

@fingolfin
Copy link
Member

Thanks, useful! @wdecker this allows you to do bibtex references as you asked for

@fingolfin fingolfin merged commit 17e1dfb into oscar-system:master Mar 11, 2021
@fingolfin
Copy link
Member

@GDeFranceschi you can add any other refs now and cite them (e.g. add your thesis!)

@GDeFranceschi
Copy link
Contributor

Sure, I'll add them in the branch ManualGroups.

@rfourquet rfourquet deleted the rf/citations branch March 12, 2021 07:31
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

Successfully merging this pull request may close these issues.

3 participants