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

Online documentation needed #38

Closed
Ivorforce opened this issue Sep 4, 2024 · 2 comments
Closed

Online documentation needed #38

Ivorforce opened this issue Sep 4, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Ivorforce
Copy link
Owner

See also: #11

NumDot needs some introductions and proper online documentation pages, akin to the godot docs and the xtensor docs.

I cannot say which documentation system is best as i have not worked with any of them myself. It is very possible that the built-in documentation system we'll build in #11 can be used to auto-generate online pages. In that case, that would be the best approach.

@Ivorforce Ivorforce added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Sep 4, 2024
@Ivorforce
Copy link
Owner Author

Ivorforce commented Sep 13, 2024

Godot updates its online class reference automatically with doxygen, which feeds into Sphinx.

The doc-class primer describes that you have to run make rst in /doc to generate the html files. The Makefile simply runs make_rst.py to generate rst files, which are later adapted in Sphinx.

I proposed this tool get exposed to gdextension. I might take a stab at this myself.

@Ivorforce
Copy link
Owner Author

Online documentation is now available: https://numdot.readthedocs.io/en/latest/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant