File tree Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Original file line number Diff line number Diff line change
1
+ ---
2
+ title : " Cyphesis Python docs"
3
+ date : 2023-01-10
4
+ ---
5
+
6
+ The Cyphesis server is mainly written in C++ and provides scripting though Python. All the rules that make the world
7
+ tick are written in Python. However, so far there hasn't been a good way to provide good documentation for the bindings.
8
+ Any Python develop would have had to either look at previous code, or look up the actual bindings themselves.
9
+
10
+ With a recent [ change] ( https://github.com/worldforge/cyphesis/commit/a1860e719f511a4d73dd619eb63d379d777b9bb7 ) we now
11
+ provide automated Python [ "stubs"] ( https://github.com/worldforge/cyphesis/tree/master/docs/python ) , which helps a
12
+ lot. The documentation isn't complete as we're currently missing the properties of the classes; we so far only expose
13
+ the methods and functions. However, it's a good start to allow for a better developer experience.
14
+
15
+ If you're doing development, now make sure that the directory "docs/python" is included into your Python paths, and
16
+ you should get access to these stubs.
You can’t perform that action at this time.
0 commit comments