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

[Documentation] A sphinx documentation generator #79

Open
mratsim opened this issue Nov 21, 2017 · 4 comments
Open

[Documentation] A sphinx documentation generator #79

mratsim opened this issue Nov 21, 2017 · 4 comments

Comments

@mratsim
Copy link
Collaborator

mratsim commented Nov 21, 2017

Since Nim is using Python comment syntax, and RST by default, all is in place for Sphinx.

Compared to Nimdoc, Sphinx allows separation on multiple pages and mathematical formulas that may be needed for all the scientific stack.

There is an example of bindings here.

@cvanelteren
Copy link

Any update on this?

@digitalcraftsman
Copy link

You might have a look at https://github.com/pietroppeter/nimibook.

@cvanelteren
Copy link

@digitalcraftsman thanks!

@a-mr
Copy link

a-mr commented Jan 26, 2022

separation on multiple pages

@mratsim What do you mean? Can you provide a link?

mathematical formulas

This should not be too difficult to implement — even for HTML using KaTeX.
AFAIK current RST syntax already has the .. math:: directive and :math: role.

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

4 participants