Skip to content

Commit 0f687cc

Browse files
authored
Merge pull request RustPython#4246 from dvermd/document_code_generation
Document code generation
2 parents d0fe03c + 02af970 commit 0f687cc

File tree

2 files changed

+8
-133
lines changed

2 files changed

+8
-133
lines changed

DEVELOPMENT.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,14 @@ the Rust code used to represent different Python objects and their methods. The
191191
core implementation of what a Python object is can be found in
192192
`vm/src/pyobjectrc.rs`.
193193

194+
### Code generation
195+
196+
There are some code generations involved in building RustPython:
197+
198+
- some part of the AST code is generated from `vm/src/stdlib/ast/gen.rs` to `compiler/ast/src/ast_gen.rs`.
199+
- the `__doc__` attributes are generated by the
200+
[__doc__](https://github.com/RustPython/__doc__) project which is then included as the `rustpython-doc` crate.
201+
194202
## Questions
195203

196204
Have you tried these steps and have a question, please chat with us on

scripts/generate_docs.py

Lines changed: 0 additions & 133 deletions
This file was deleted.

0 commit comments

Comments
 (0)