0
0
In Migration: New Blender Developer Documentation Platform. Currently wiki.blender.org is still the official platform.
Go to file
2024-01-18 14:38:05 +01:00
AUTO_CONVERT Wiki migration: Fixes for redirects 2024-01-18 13:49:50 +01:00
docs Document checking the active shape key lock from python code. 2024-01-18 14:38:05 +01:00
theme_overrides Fix incorrect URL in stylesheet 2023-12-12 11:11:36 +01:00
.gitattributes Initial commit, adding readme 2023-12-07 16:37:03 +01:00
.gitignore Update .gitignore for temporary python and editor files 2023-12-31 01:37:43 +01:00
hooks.py Silence info message about folder links in navigation.md 2023-12-31 01:19:41 +01:00
LICENSE Add CC-BY-SA 4.0 license file 2023-12-07 17:21:41 +01:00
mkdocs.yml Contribute: Build instructions tweaks, add Update section 2024-01-15 17:03:57 +01:00
README.md Readme: Make introduction sentence reflect state better 2024-01-10 18:52:45 +01:00
requirements.txt Simplify captioning and aligning images 2024-01-01 15:11:33 +01:00

Blender Developer Documentation

In Migration: New Blender Developer Documentation platform using Material for MkDocs.
The generated documentation is live on developer.blender.org/docs

The official platform for developer documentation is still wiki.blender.org.

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.