Blender Developer Documentation.
Alaska
1929528ba0
This commit updates the "Commiting Test Data" section to include information on how to make sure your tests are passing using the build bot before commiting the changes to main. Co-authored-by: Weizhen Huang <weizhen@blender.org> Pull Request: blender/blender-developer-docs#77 |
||
|---|---|---|
| .gitea | ||
| docs | ||
| theme_overrides | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| hooks.py | ||
| LICENSE | ||
| Makefile | ||
| mkdocs.yml | ||
| README.md | ||
| requirements.txt | ||
Blender Developer Documentation
New Blender Developer Documentation platform using Material for
MkDocs.
The generated documentation is live on
developer.blender.org/docs
This is the successor of the developer Wiki, which was archived in January 2024.
Building this Documentation Offline
The following assumes Python 3, pip, Git and Git LFS are installed.
Set up Git LFS for the current user:
git lfs install
Clone the documentation sources:
git clone https://projects.blender.org/blender/blender-developer-docs.git developer-docs
This will clone the sources into a developer-docs directory inside the current
one.
Install all dependencies, such as Material for MkDocs:
python -m pip install -r requirements.txt
Build this documentation with live reloading:
mkdocs serve
Alternatively mkdocs build will generate the documentation as HTML into a
site/ directory. Simply open site/index.html in a browser.