Page MenuHome

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.

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).
Forum: Documentation category on Developer Talk
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

Today

Aaron Carlisle (Blendify) updated the task description for T85053: 2.93 Documentation.
Thu, Apr 15, 5:19 AM · BF Blender (2.93), Documentation
Aaron Carlisle (Blendify) updated the task description for T85053: 2.93 Documentation.
Thu, Apr 15, 5:18 AM · BF Blender (2.93), Documentation

Yesterday

Jean-Yves Grosbeau (JeanYvesGrosbeau) added a comment to T87420: Object selection before Vertex Groups weight painting for Bones.

The issue of the manuel I want to report is not how to select the bones while Weight painting
That has been effectively fixed in rBM7784.
But to be able to select the bones in the weight Paint mode of the mesh,
the armature must be "activated" in some way and the way described in the manuel is wrong in my opinion.

Wed, Apr 14, 12:36 PM · Documentation

Tue, Apr 13

Alaska (Alaska) closed T87455: Spelling as Resolved by committing rBM7949: Fix T87455: Fix grammatical errors found in the retopology page.
Tue, Apr 13, 11:10 AM · Documentation
Alaska (Alaska) changed the status of T87455: Spelling from Needs Triage to Confirmed.
Tue, Apr 13, 11:04 AM · Documentation
peter moueza (moueza) created T87455: Spelling.
Tue, Apr 13, 9:29 AM · Documentation

Mon, Apr 12

Aaron Carlisle (Blendify) closed T86650: Spline generator does not work as Resolved.

Fixed with rBA1dbdb95ed93a and rBM7936

Mon, Apr 12, 7:59 PM · Documentation
Jean-Yves Grosbeau (JeanYvesGrosbeau) added a comment to T87420: Object selection before Vertex Groups weight painting for Bones.

Actually the issue is in the manuel.
You have to exit the Pose Mode to select a Mesh object in the 2.8 and 2.9 Blender versions.
First you select the armature, you don't bring it to Pose Mode,
instead you add the Mesh to the selection to set it the active object
and you change from Object Mode to Weight Paint Mode and then the description in the manuel is correct.

Mon, Apr 12, 6:16 PM · Documentation
Aaron Carlisle (Blendify) changed the status of T87420: Object selection before Vertex Groups weight painting for Bones from Needs Triage to Needs Information from User.

This should be fixed with rBM7784 can you confirm that the behavior described in the 2.93 user manual: https://docs.blender.org/manual/en/2.93/ works as expected.

Mon, Apr 12, 5:35 PM · Documentation
Jean-Yves Grosbeau (JeanYvesGrosbeau) created T87420: Object selection before Vertex Groups weight painting for Bones.
Mon, Apr 12, 2:23 PM · Documentation
Julian Eisel (Severin) merged task T87372: VR scene inspection shows ok in Blender, but a pink-void on HP Reverb G2 headset into T76082: VR Scene Inspection: It shows me only a pink screen. (It doesn't support AMD GPU).
Mon, Apr 12, 11:54 AM · Documentation

Sun, Apr 11

Vladimir Spivak (cwolf3d) edited projects for T86650: Spline generator does not work, added: Documentation; removed Add-ons (Community).
Sun, Apr 11, 8:17 PM · Documentation
Vladimir Spivak (cwolf3d) merged task T86773: Addons won't turn on, addons / add_curve / extra_objects into T86650: Spline generator does not work.
Sun, Apr 11, 8:16 PM · Documentation

Sat, Apr 10

Peter F (Pfil112) created T87372: VR scene inspection shows ok in Blender, but a pink-void on HP Reverb G2 headset.
Sat, Apr 10, 12:52 PM · Documentation
Alaska (Alaska) closed T87354: Documentation: Link doesn't work as Resolved by committing rBM7935: Fix T87354: Incorrect formatting for link in Add-on tutorial page..
Sat, Apr 10, 2:16 AM · Documentation
Alaska (Alaska) changed the status of T87354: Documentation: Link doesn't work from Needs Triage to Confirmed.
Sat, Apr 10, 1:31 AM · Documentation

Fri, Apr 9

Julian Eisel (Severin) moved T83580: Manual & Release Notes Docs from Product Backlog to Blocking Tasks on the Asset Browser (Milestone 1: Basic, Local Asset Browser) board.
Fri, Apr 9, 12:07 AM · Documentation, Asset Browser (Milestone 1: Basic, Local Asset Browser)

Sun, Apr 4

Andrea Leganza (Neogene) added a comment to T87180: Tutorial addon sample (Move X by One) doesn't get executed and/or added as available voice when installed..

@Aaron Carlisle (Blendify) Since operators that aren't in menus are omitted from the search by default, the tutorial should explain that the Developer Extras have to be enabled or showcase it by calling the operator from the console.

Sun, Apr 4, 8:12 AM · Documentation
Robert Guetzkow (rjg) edited projects for T87180: Tutorial addon sample (Move X by One) doesn't get executed and/or added as available voice when installed., added: Documentation; removed BF Blender.

@Aaron Carlisle (Blendify) Since operators that aren't in menus are omitted from the search by default, the tutorial should explain that the Developer Extras have to be enabled or showcase it by calling the operator from the console.

Sun, Apr 4, 12:37 AM · Documentation

Fri, Apr 2

Aaron Carlisle (Blendify) closed D10778: User Manual Documentation: Compositor Anti-Aliasing node.
Fri, Apr 2, 7:21 PM · Compositing, Documentation
Rombout Versluijs (rombout) created T87129: Article states wrongly particle can be edittied after bake.
Fri, Apr 2, 6:19 AM · Documentation

Thu, Apr 1

Sybren A. Stüvel (sybren) added a comment to T87008: EnumProperty warning hidden behind scrolling area.

If reverted we get the very long icon lists back (which is arguably acceptable, as hiding information across all docs risks script authors missing important details, where as the long enum lists only impacts the user-interface methods).

Personally I don't care much about the exact solution. If this warning is overlooked it can crash Blender, so it should simply be in a place where people actually see it. If that means taking it out of the parameter list and moving it into the main description of the function, that's fine by me.

Thu, Apr 1, 12:35 PM · Documentation
Jacob Merrill (blueprintrandom) added a comment to T72537: Documentation: Random Per Island not working on Eevee/Material Preview not mentioned.

is this able to be made to work in eevee?

Thu, Apr 1, 4:46 AM · Documentation, EEVEE & Viewport, BF Blender

Wed, Mar 31

Aaron Carlisle (Blendify) requested changes to D10778: User Manual Documentation: Compositor Anti-Aliasing node.

Make sure to wrap long lines before 120 characters, otherwise looks good.

Wed, Mar 31, 11:29 PM · Compositing, Documentation
Aaron Carlisle (Blendify) claimed T87008: EnumProperty warning hidden behind scrolling area.
Wed, Mar 31, 7:47 PM · Documentation
Aaron Carlisle (Blendify) changed the status of T87008: EnumProperty warning hidden behind scrolling area from Needs Triage to Confirmed.

If we are a bit more restrictive on the CSS selector, I have a solution that seems to work. I need to test it out a bit more to make sure it doesn't cause any regressions else where.

Wed, Mar 31, 7:47 PM · Documentation
Falk David (filedescriptor) closed D10856: Animation: Add documentation for paste options.
Wed, Mar 31, 2:46 PM · Animation & Rigging, Documentation
Campbell Barton (campbellbarton) updated subscribers of T87008: EnumProperty warning hidden behind scrolling area.
Wed, Mar 31, 8:56 AM · Documentation
Campbell Barton (campbellbarton) added a comment to T87008: EnumProperty warning hidden behind scrolling area.

Caused by doc/python_api/static/css/theme_overrides.css, fix for T76453: Some args/props in the API docs take *so much* space.

Wed, Mar 31, 8:54 AM · Documentation
Aaron Carlisle (Blendify) accepted D10856: Animation: Add documentation for paste options.
Wed, Mar 31, 3:36 AM · Animation & Rigging, Documentation

Tue, Mar 30

Falk David (filedescriptor) retitled D10856: Animation: Add documentation for paste options from Animation: Add documentation for past options to Animation: Add documentation for paste options.
Tue, Mar 30, 10:53 AM · Animation & Rigging, Documentation
Falk David (filedescriptor) requested review of D10856: Animation: Add documentation for paste options.
Tue, Mar 30, 10:53 AM · Animation & Rigging, Documentation

Mon, Mar 29

Habib Gahbiche (zazizizou) updated the diff for D10778: User Manual Documentation: Compositor Anti-Aliasing node.
  • using two images for corner rounding instead of one
Mon, Mar 29, 9:37 PM · Compositing, Documentation
Sybren A. Stüvel (sybren) updated the task description for T87008: EnumProperty warning hidden behind scrolling area.
Mon, Mar 29, 11:16 AM · Documentation
Sybren A. Stüvel (sybren) updated the task description for T87008: EnumProperty warning hidden behind scrolling area.
Mon, Mar 29, 11:15 AM · Documentation
Sybren A. Stüvel (sybren) created T87008: EnumProperty warning hidden behind scrolling area.
Mon, Mar 29, 11:15 AM · Documentation
Jeroen Bakker (jbakker) added a comment to D10778: User Manual Documentation: Compositor Anti-Aliasing node.

We might want to add a different example for compositing_types_filter_antialiasing-node_example-2-corner_rounding.gif. this image uses a different aspect ratio and isn't clear what frame represents what value. I would use 2 images to make this more clear.

Mon, Mar 29, 9:36 AM · Compositing, Documentation
Jeroen Bakker (jbakker) added inline comments to D10778: User Manual Documentation: Compositor Anti-Aliasing node.
Mon, Mar 29, 9:30 AM · Compositing, Documentation
Jeroen Bakker (jbakker) requested changes to D10778: User Manual Documentation: Compositor Anti-Aliasing node.
Mon, Mar 29, 9:19 AM · Compositing, Documentation
Aaron Carlisle (Blendify) added a comment to T86774: Mist Pass in World Settings not mentions activation of Mist Pass to see settings.

We don't have a great system for updating docs before 2.92 but I can see about pushing an update to 2.92.

Mon, Mar 29, 1:22 AM · Documentation

Sun, Mar 28

Xenia Juhl (Xenia) added a comment to T86774: Mist Pass in World Settings not mentions activation of Mist Pass to see settings.

It would be great, to have the Note also added to the descriptions of 2.83, 2.90, 2.91, 2.92.

Sun, Mar 28, 11:15 PM · Documentation
Habib Gahbiche (zazizizou) updated the diff for D10778: User Manual Documentation: Compositor Anti-Aliasing node.
  • removed image scaling
  • made images bigger instead
Sun, Mar 28, 4:17 PM · Compositing, Documentation
Habib Gahbiche (zazizizou) retitled D10778: User Manual Documentation: Compositor Anti-Aliasing node from Use Manual Documentation: Compositor Anti-Aliasing node to User Manual Documentation: Compositor Anti-Aliasing node.
Sun, Mar 28, 4:16 PM · Compositing, Documentation

Thu, Mar 25

Aaron Carlisle (Blendify) updated the task description for T85053: 2.93 Documentation.
Thu, Mar 25, 10:26 PM · BF Blender (2.93), Documentation
Aaron Carlisle (Blendify) updated the task description for T85053: 2.93 Documentation.
Thu, Mar 25, 10:23 PM · BF Blender (2.93), Documentation
Aaron Carlisle (Blendify) updated the task description for T85053: 2.93 Documentation.
Thu, Mar 25, 10:21 PM · BF Blender (2.93), Documentation
Aaron Carlisle (Blendify) updated the task description for T85053: 2.93 Documentation.
Thu, Mar 25, 9:41 PM · BF Blender (2.93), Documentation
Aaron Carlisle (Blendify) updated the task description for T85053: 2.93 Documentation.
Thu, Mar 25, 9:39 PM · BF Blender (2.93), Documentation
Aaron Carlisle (Blendify) updated the task description for T85053: 2.93 Documentation.
Thu, Mar 25, 9:37 PM · BF Blender (2.93), Documentation

Tue, Mar 23

Aaron Carlisle (Blendify) added a comment to T56342: Policy for user-manual fIle downloads (re-evaluate).

Size limit - disagree: This heavyly depends on the manual topic the file covers

Tue, Mar 23, 4:12 AM · Documentation