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

come up with a good framework for citing stuff in docstrings #3911

Closed
malb opened this issue Aug 20, 2008 · 4 comments
Closed

come up with a good framework for citing stuff in docstrings #3911

malb opened this issue Aug 20, 2008 · 4 comments

Comments

@malb
Copy link
Member

malb commented Aug 20, 2008

the framework should allow to generate a bibliography etc. while not reinventing the wheel: BibTeX? By citing in docstrings I mean stuff like this:

INPUT:
   foo -- bar (as described in [BCDT]

REFERENCES:
[BCDT] Breuil, Conrad, Diamond, Taylor, "Modularity ...."

Component: documentation

Issue created by migration from https://trac.sagemath.org/ticket/3911

@malb
Copy link
Member Author

malb commented Apr 27, 2009

comment:1

This is fixed thanks to Sphinx and ReST which has native support for this.

@malb malb closed this as completed Apr 27, 2009
@sagetrac-mabshoff
Copy link
Mannequin

sagetrac-mabshoff mannequin commented Apr 27, 2009

comment:2

Well, it should be documented in some way how we do things things. If such documentation exists a link from the ticket would be nice.

Cheers,

Michael

@sagetrac-mabshoff sagetrac-mabshoff mannequin added this to the sage-3.4.2 milestone Apr 27, 2009
@sagetrac-mabshoff sagetrac-mabshoff mannequin removed the wishlist item label Apr 27, 2009
@malb
Copy link
Member Author

malb commented Apr 27, 2009

comment:3

It is a standard feature of ReST, see: http://sphinx.pocoo.org/rest.html#citations

@sagetrac-mabshoff
Copy link
Mannequin

sagetrac-mabshoff mannequin commented Apr 27, 2009

comment:4

Replying to @malb:

It is a standard feature of ReST, see: http://sphinx.pocoo.org/rest.html#citations

I now that. I meant in Sage's documentation so that documentation writes in Sage will use it :).

Cheers,

Michael

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

No branches or pull requests

1 participant