Are you sure you want to delete this task? Once this task is deleted, it cannot be recovered.
awaelchli e0307277a0 | 1 week ago | |
---|---|---|
.. | ||
source-app | 1 month ago | |
source-fabric | 1 week ago | |
source-pytorch | 1 week ago | |
README.md | 8 months ago | |
crossroad.html | 5 months ago | |
generate_docs_for_tags.sh | 1 year ago | |
redirect.html | 7 months ago | |
rtfd-build.sh | 5 months ago |
We are using Sphinx with Napoleon extension.
Moreover, we set Google style to follow with type convention.
See following short example of a sample function taking one position string and optional
from typing import Optional
def my_func(param_a: int, param_b: Optional[float] = None) -> str:
"""Sample function.
Args:
param_a: first parameter
param_b: second parameter
Return:
sum of both numbers
Example::
>>> my_func(1, 2)
3
Note:
If you want to add something.
"""
p = param_b if param_b else 0
return str(param_a + p)
When updating the docs, make sure to build them first locally and visually inspect the html files in your browser for
formatting errors. In certain cases, a missing blank line or a wrong indent can lead to a broken layout.
Run these commands
git submodule update --init --recursive
make docs
and open docs/build/html/index.html
in your browser.
When you send a PR the continuous integration will run tests and build the docs.
Notes:
sudo apt-get update && sudo apt-get install -y texlive-latex-extra dvipng texlive-pictures
sudo apt-get install pandoc
When developing the docs, building docs can be VERY slow locally because of the notebook tutorials.
To speed this up, enable this flag in before building docs:
# builds notebooks which is slow
export FAST_DOCS_DEV=0
# fast notebook build which is fast
export FAST_DOCS_DEV=1
To change the CSS theme of the docs, go here.
Apologies in advance... this is a bit complex to build and requires basic understanding of javascript/npm.
No Description
Python YAML TSX Dockerfile Shell other
Dear OpenI User
Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.
For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》