[Doc] Add documentation for gui system and install trouble shooting. #2985
Conversation
|
✔️ Deploy Preview for jovial-fermat-aa59dc ready! 🔨 Explore the source changes: e4b90be 🔍 Inspect the deploy log: https://app.netlify.com/sites/jovial-fermat-aa59dc/deploys/6154634e17c3d30008d019e5 😎 Browse the preview: https://deploy-preview-2985--jovial-fermat-aa59dc.netlify.app |
One option would be to use https://github.com/taichi-dev/public_files. If we create a new folder under |
I had a conversation with @rexwangcc and concluded that adding a static/asset folder for example images would be great. |
|
nit: |
|
/format |
| @@ -16,7 +16,7 @@ python3 -m pip install taichi | |||
| ``` | |||
|
|
|||
| :::note | |||
| Currently, Taichi only supports Python 3.6/3.7/3.8 (64-bit). | |||
| Currently, Taichi only supports Python 3.6/3.7/3.8/3.9 (64-bit). | |||
There was a problem hiding this comment.
How about we take this opportunity to schedule Taichi's deprecation for 3.6 by 2022 :-)? https://endoflife.date/python @ailzhang @Zheaoli @strongoier
There was a problem hiding this comment.
Sounds good! Maybe we should mention that taichi'll do one major verison official release for 3.6 after its EOL and then we'll stop py36 releases?
There was a problem hiding this comment.
Sounds great! Maybe we can make a deprecated roadmap/strategy to get a major version to drop the Python 3.6 support, then we can add log info to show the deprecated warning. After this, the developer will get some information when they execute import taichi in Python 3.6
|
|
||
| The color of triangles can be further specified with additional parameter. | ||
|
|
||
| For example: |
There was a problem hiding this comment.
nit: newline for code blocks and headers
| ```python | ||
| gui.circles(pos, radius=3, color=0x068587) | ||
| ``` | ||
| draws circles all with radius of 1.5 and blue color positioned at pos array. |
There was a problem hiding this comment.
I guess the radius argument in gui.circles means diameter right? This might confuse people.
Also, we should mention the unit of the digit radius=3 here, is this number of pixels or something else.
There was a problem hiding this comment.
Renaming requires modify python API code. I think we should leave this to another PR and focus on docs changing in this one.
| [`ti.imresize(img, w)`](https://api-docs.taichi.graphics/src/taichi.misc.html?highlight=imresize#taichi.misc.image.imresize) | ||
| resizes the img specified. | ||
|
|
||
| ## Zero-copying frame buffer |
There was a problem hiding this comment.
Is there any limitation of this option? Why fast_gui is not a default choice?
There was a problem hiding this comment.
I believe the limitation is in the caution part.
Work in progress.
Made new folder static/asset under articles. I use this to store example images in docs.