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

adding -f rst option to compiler (restructured text) #20

Open
hemmecke opened this issue Jul 23, 2013 · 0 comments
Open

adding -f rst option to compiler (restructured text) #20

hemmecke opened this issue Jul 23, 2013 · 0 comments

Comments

@hemmecke
Copy link
Collaborator

The compiler should be able to generate .rst files (restructured text) from the ++ pre- and postdoc documentation.

At the moment there is not clear specification of how pre/postdocs should be formatted. I propose to use ReStructuredText, since it is easily readable in plain text form and one could aim at using sphinx http://sphinx-doc.org/ in order to produce a nice api description of the library. We could even keep that up to date (with every push) by using the http://readthedocs.org service.

Requirement, let the compiler produce appropriate .rst files that generate from something like

foo: A -> B
    ++ blah blah

a .rst file that contains the signature in a human-readable form together with the pre/postoc.

It should be possible to extract such .rst files from the .ao files.

PS: Together with MathJax one would be allowed to use mathematical text inside special rst constructs, like math:'...'

PPS: Maybe we can learn a lot from the Sage community.

@pbroadbery pbroadbery modified the milestones: 1.4, Wishlist Apr 19, 2017
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

2 participants