Blender Developer Documentation. https://developer.blender.org/docs/
Go to file
Jacques Lucke 49e1784412
buildbot/vdev-doc-developer Build done. Details
buildbot/vdev-doc-developer-coordinator Build done. Details
Update docs/release_notes/4.1/python_api.md
2024-03-01 22:37:39 +01:00
.gitea Gitea: Don't display empty "Default" issue template 2024-02-15 12:08:56 +01:00
docs Update docs/release_notes/4.1/python_api.md 2024-03-01 22:37:39 +01:00
theme_overrides Update/replace Wiki links 2024-01-23 17:12:02 +01:00
.editorconfig Add .editorconfig file 2024-01-30 11:35:43 +01:00
.gitattributes Initial commit, adding readme 2023-12-07 16:37:03 +01:00
.gitignore Git: Add thumnail files to gitignore 2024-02-09 19:40:42 +01:00
LICENSE Add CC-BY-SA 4.0 license file 2023-12-07 17:21:41 +01:00
README.md Readme: Add link to #developer-documentation chat 2024-01-23 17:46:25 +01:00
hooks.py Silence info message about folder links in navigation.md 2023-12-31 01:19:41 +01:00
mkdocs.yml Plugins: Enable redirects plugin 2024-02-09 18:12:07 +01:00
requirements.txt Plugins: Enable redirects plugin 2024-02-09 18:12:07 +01:00

README.md

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.