DocumentationProject
ActivePublic

Details

Description

Blender Documentation (latest manual build)

Welcome to the Blender User Documentation project. We are actively searching for contributors and documentation module owners.
This project aims at replacing and updating the current Blender Manual.

The Blender Manual is written using reStructuredText (RST) and is built with Sphinx.

If you want to start contributing or want to have a look at the manual, here we have some instructions.

How to build & edit the docs locally

Before you start contributing it may be helpful to read the style guides which give instructions on how to write with RST and some goals of the manual.

Now that you are familiar with the process, you can get setup, edit, and contribute your changes by following these links:

  1. Install
  2. Build
  3. Edit
  4. Build again
  5. Patch or Commit
NOTE: We realize this may be intimidating if you're not familiar with Subversion or making patches, you may also submit the modified file as a Phabricator task, or mail the bf-docboard mailing list.

Links

Manual Docs: Manual/About (the process for editing the manual).
Source Files: Manual Repository (subversion repository).
Mailing List: bf-docboard
Administrators: @Aaron Carlisle (Blendify) @Francesco Siddi (fsiddi)


Documentation Team

The coordination of the Blender Manual is run by a set of Administrators,
which are responsible for managing the whole project and infrastructures. (listed above)

If you are interested in becoming a contributor, please contact us on the bf-docboard mailing list.

Translations

For translations, we use Sphinx’s internationalization package. To get started see https://docs.blender.org/manual/en/dev/about/contribute/index.html#translations

Links

Source Files: Translation's Repository (subversion repository).
Mailing List: bf-docboard
Administrators: @Aaron Carlisle (Blendify) , @Francesco Siddi (fsiddi)

NOTE: If you are a new translator who wants to start translating a new language that is not listed below send and email to the bf-docboard and we would be glad to set it up for you.

Recent Activity

Mon, Dec 11

Daniel Flaum (DanielFlaum) added a comment to D2957: Improvement of Modeling/Meshes/Editing/Normals.

Here is the new image:

Mon, Dec 11, 2:08 AM · Documentation
Daniel Flaum (DanielFlaum) created D2957: Improvement of Modeling/Meshes/Editing/Normals.
Mon, Dec 11, 2:07 AM · Documentation

Fri, Dec 8

João Seixas (j_seixas) retitled D2952: Fix T53404 - Python API documentation: UI Layout Emboss description wording from T53404 to Fix T53404 - Python API documentation: UI Layout Emboss description wording.
Fri, Dec 8, 10:52 PM · Python, Documentation
João Seixas (j_seixas) created D2952: Fix T53404 - Python API documentation: UI Layout Emboss description wording.
Fri, Dec 8, 7:02 PM · Python, Documentation

Fri, Nov 17

Vuk Gardašević (lijenstina) added a comment to T53286: Upgrade information is missing in manual.

Adding a note about saving User Preferences with daily (developer) builds would be nice too (a warning about possible issues - corruption if something crashes like an add-on etc).

Fri, Nov 17, 11:09 AM · Documentation

Wed, Nov 15

Aaron Carlisle (Blendify) triaged T53329: Stack traces are only available on linux and osMac (Not windows) as Normal priority.
Wed, Nov 15, 7:23 PM · Documentation
Aaron Carlisle (Blendify) created T53329: Stack traces are only available on linux and osMac (Not windows).
Wed, Nov 15, 7:23 PM · Documentation

Nov 10 2017

ronan ducluzeau (zeauro) triaged T53292: blender vse cant deal with exr files as Confirmed priority.

Documentation states that a Frame Sequence Approach to render animations is possible with .exr multilayer, JPG or PNG.
Then, it indicates that you use Blender's compositor and Blender's VSE.

Nov 10 2017, 5:29 PM · Documentation
Denis (dns_di) created T53292: blender vse cant deal with exr files.
Nov 10 2017, 4:23 PM · Documentation
Sybren A. Stüvel (sybren) triaged T53286: Upgrade information is missing in manual as Normal priority.
Nov 10 2017, 12:21 PM · Documentation
Sybren A. Stüvel (sybren) created T53286: Upgrade information is missing in manual.
Nov 10 2017, 12:21 PM · Documentation

Nov 1 2017

Tobias Heinke (TobiasH) added a comment to D2880: Vector Blur filter compositing node example.

When you're ready then you can commit it.

Nov 1 2017, 2:27 PM · Documentation

Oct 30 2017

Aaron Carlisle (Blendify) triaged T53197: Reference Usage in manual lacks necessary Editor Type prerequisite information as Confirmed priority.

Thanks for reporting and I agree that it is an issue. Although like a couple issues in the manual there is an issue in the UI of Blender that causes errors like this. Luckily in Blender 2.8 at least this specific example will not be an issue as the "Global Topbar" feature gets added.

Oct 30 2017, 5:30 PM · Documentation
Vuk Gardašević (lijenstina) edited projects for T53197: Reference Usage in manual lacks necessary Editor Type prerequisite information, added: Documentation; removed BF Blender.
Oct 30 2017, 3:04 PM · Documentation

Oct 27 2017

Aaron Carlisle (Blendify) triaged T53177: Documentation: Error in formula for specularity calculation hint as Normal priority.
Oct 27 2017, 10:27 PM · Documentation
Pavel (skripkin) added a comment to T53177: Documentation: Error in formula for specularity calculation hint.

Oh, I see. Thank you for that clarification.

Oct 27 2017, 3:59 PM · Documentation
Riccardo Giovanetti (harvester) added a comment to T53177: Documentation: Error in formula for specularity calculation hint.

As per the R(0°) formula the "sqr" term should stand for or should be read as "to the power of 2" or "squared" not as "square root of":

Oct 27 2017, 3:08 PM · Documentation
Pavel (skripkin) created T53177: Documentation: Error in formula for specularity calculation hint.
Oct 27 2017, 10:38 AM · Documentation

Oct 23 2017

Glen Larsen (g60) updated the diff for D2880: Vector Blur filter compositing node example.

Use preferred caption.

Oct 23 2017, 11:14 PM · Documentation
Glen Larsen (g60) added a comment to D2880: Vector Blur filter compositing node example.

I can barely spot the difference between the 32/64 images and I can switch back and forth.
I think it's not worth adding the last 2 images, because the add not enough of new info.

Oct 23 2017, 11:07 PM · Documentation
Tobias Heinke (TobiasH) accepted D2880: Vector Blur filter compositing node example.

I (personally) prefer the spelled out caption, thus not to use "=".

Oct 23 2017, 11:05 PM · Documentation
Glen Larsen (g60) updated the diff for D2880: Vector Blur filter compositing node example.

Removed 2nd set of examples from original edit.

Oct 23 2017, 10:50 PM · Documentation
Tobias Heinke (TobiasH) added a comment to D2880: Vector Blur filter compositing node example.

I can barely spot the difference between the 32/64 images and I can switch back and forth.
I think it's not worth adding the last 2 images, because the add not enough of new info.
What is the hint?

Oct 23 2017, 8:08 PM · Documentation
marc dion (marcclintdion) removed a member for Documentation: marc dion (marcclintdion).
Oct 23 2017, 7:51 PM

Oct 14 2017

Glen Larsen (g60) created D2880: Vector Blur filter compositing node example.
Oct 14 2017, 12:03 AM · Documentation

Oct 9 2017

Aaron Carlisle (Blendify) closed D2874: Updates to Cycles Gradient Texture Node Docs by committing rBM3785: Updates to Cycles Gradient Texture Node Docs.
Oct 9 2017, 5:10 PM · Documentation
Aaron Carlisle (Blendify) claimed T53031: External links in offline manual download.
Oct 9 2017, 4:10 PM · Documentation
Aaron Carlisle (Blendify) added a comment to D2874: Updates to Cycles Gradient Texture Node Docs.

Looks good, I will commit when I have time

Oct 9 2017, 4:07 PM · Documentation
Aaron Carlisle (Blendify) accepted D2874: Updates to Cycles Gradient Texture Node Docs.
Oct 9 2017, 4:07 PM · Documentation
Shane Ambler (sambler) created T53031: External links in offline manual download.
Oct 9 2017, 8:42 AM · Documentation
Ben Marshall (jaguar) created D2874: Updates to Cycles Gradient Texture Node Docs.
Oct 9 2017, 7:44 AM · Documentation
Campbell Barton (campbellbarton) closed T53029: Link rot on this page as Resolved by committing rBM3784: Fix T53029: Broken link.
Oct 9 2017, 6:55 AM · Documentation
Rafael Navega (RN) created T53029: Link rot on this page.
Oct 9 2017, 6:48 AM · Documentation
Aaron Carlisle (Blendify) closed D2869: Spelling fixes for Cycles Mapping Node by committing rBM3783: Spelling fixes for Cycles Mapping Node.
Oct 9 2017, 6:15 AM · Documentation

Oct 6 2017

Aaron Carlisle (Blendify) added a member for Documentation: Glen Larsen (g60).
Oct 6 2017, 4:14 PM
Aaron Carlisle (Blendify) accepted D2869: Spelling fixes for Cycles Mapping Node.

I will commit when I get on a real computer.

Oct 6 2017, 4:08 PM · Documentation
Ben Marshall (jaguar) created D2869: Spelling fixes for Cycles Mapping Node.
Oct 6 2017, 6:47 AM · Documentation

Oct 2 2017

Julian Eisel (Severin) updated the task description for T48096: New Wiki.
Oct 2 2017, 9:04 PM · Documentation, Infrastructure: Websites

Oct 1 2017

Tobias Heinke (TobiasH) edited Description on Documentation.
Oct 1 2017, 5:25 PM

Sep 29 2017

Aaron Carlisle (Blendify) reopened T52949: RGB-value difference in UI as "Open".
Sep 29 2017, 5:39 PM · Documentation

Sep 28 2017

Glen Larsen (g60) added a watcher for Documentation: Glen Larsen (g60).
Sep 28 2017, 7:51 PM

Sep 25 2017

Brendon Murphy (meta-androcto) added a comment to T48096: New Wiki.

hi,
https://wiki.blender.org/index.php/Extensions:2.6/Py/Scripts
could be archived and a new set of pages created for addons.
as one of the original authors and designers of this page and
https://wiki.blender.org/index.php/Extensions:2.4/Py/Scripts
I would be happy to work with wiki devs to see the new pages created for blender 2.8 series.

Sep 25 2017, 11:19 AM · Documentation, Infrastructure: Websites

Sep 24 2017

xan2622 (xan2622) added a comment to T48096: New Wiki.

Is it planned to allow to log in to the (upcoming) new wiki with a developer.blender.org account?
I hope it will be considered because it's not currently possible to log into wiki.blender.org with a developer.blender.org account...

Sep 24 2017, 12:00 PM · Documentation, Infrastructure: Websites

Sep 23 2017

Aaron Carlisle (Blendify) added a member for Documentation: Artem (mindFreeArtist).
Sep 23 2017, 4:37 PM

Sep 22 2017

Artem (mindFreeArtist) added a watcher for Documentation: Artem (mindFreeArtist).
Sep 22 2017, 7:46 PM
Jeff (bolt2009) added a watcher for Documentation: Jeff (bolt2009).
Sep 22 2017, 6:30 PM

Sep 20 2017

Bastien Montagne (mont29) closed T52842: Incorrect description for bpy.types.MeshTextureFace.uv as Resolved by committing rBf54f680a2681: Fix T52842: Incorrect description for bpy.types.MeshTextureFace.uv.
Sep 20 2017, 4:40 PM · Documentation
Bastien Montagne (mont29) claimed T52842: Incorrect description for bpy.types.MeshTextureFace.uv.

Not strictly speaking a bug, but annoying for docs indeed, will fix.

Sep 20 2017, 4:32 PM · Documentation
Constantin Makshin (dinosaur) created T52842: Incorrect description for bpy.types.MeshTextureFace.uv.
Sep 20 2017, 8:11 AM · Documentation

Sep 19 2017

Aaron Carlisle (Blendify) added a member for Documentation: Miroslav Ivanov (Myrthos).
Sep 19 2017, 9:00 PM