-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
How to document this project? #137
Comments
I think we'll have a couple of different audiences for documentation: RustPython end-users (i.e. Python developers) and people interested in RustPython internals (i.e. Rust developers). The former are more likely to be comfortable with Sphinx, and the latter with rustdoc. Given the current state of development, I would lean towards using rustdoc. We can consider if we want to produce more Python-developer-friendly once we're in a state where it's actually feasible to use RustPython without knowing about the internals/the current state of development. |
That sounds reasonable to me. I don't have much experience with either tool. |
I agree with @OddBloke that rustdoc is probably favourable here but my preference would be doing this in the |
I'm looking to take on some documentation tasks to better familiarize myself with the internals. and it would be nice to get a clear answer on this question. It appears the current state of the documentation is split between inline comments and some markdown files in the while it might be cleaner to document the project separately from the code rustdoc does not yet support this. we could of course not use There is an unstable If moving forward with inline documentation is ok what sections do people feel could benefit most from some friendly documentation? personally I feel that the macros in use would be a good place to start as that would greatly aid in helping understand the project code better. |
This is gonna be some sort of a poll. So the question is, how to write proper documentation for this project. Both rust and python have documentation options. For rust, there appears to be some rust format tool, which is the default. For python there is readthedocs and sphinx.
I now see the following options:
Proposals are welcome, we can vote them with the like options!
The text was updated successfully, but these errors were encountered: