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

Megan Weber (MCweb) added a reviewer for D6096: Fixed spelling error.: Documentation.
Sat, Oct 19, 8:22 AM · Documentation

Yesterday

Megan Weber (MCweb) created D6096: Fixed spelling error..
Fri, Oct 18, 8:24 PM · Documentation
Brendon Murphy (meta-androcto) updated the task description for T70624: 2.81 Missing Features in Manual.
Fri, Oct 18, 2:23 PM · Documentation, BF Blender (2.81), Development Management
Nathan Letwory (jesterking) claimed T70624: 2.81 Missing Features in Manual.
Fri, Oct 18, 12:31 PM · Documentation, BF Blender (2.81), Development Management

Wed, Oct 16

Dalai Felinto (dfelinto) updated the task description for T70623: 2.81 Missing Release Log Documentation.
Wed, Oct 16, 6:29 PM · Documentation, BF Blender (2.81), Development Management

Tue, Oct 15

Dalai Felinto (dfelinto) updated the task description for T70623: 2.81 Missing Release Log Documentation.
Tue, Oct 15, 3:07 AM · Documentation, BF Blender (2.81), Development Management

Fri, Oct 11

Renato Henriques (Spartacus1) added a comment to T68704: Documentation: explain that Blender 2.80 Exporting a textured OBJ with any shader other than Principled BSDF will result in an MTL without map_Kd pointing to texture file.

As Ryan said, it's tolerable that complex textures with layers are not exported. However, image textures should be exported correctly, as in any other 3D package.

Fri, Oct 11, 10:44 PM · Documentation, Import/Export, Add-ons
Ryan Ackley (ryanackley) added a comment to T68704: Documentation: explain that Blender 2.80 Exporting a textured OBJ with any shader other than Principled BSDF will result in an MTL without map_Kd pointing to texture file.

Took me days of pulling hair and googling to find that textures not exporting is by design. I don't think it's an unreasonable user expectation for simple shaders like Diffuse BDSF to export texture images. I can live with the workaround however. It's just extremely obscure and unintuitive.

Fri, Oct 11, 5:43 PM · Documentation, Import/Export, Add-ons
Val Acar (valacar) created T70722: Overlapping text when highlighting words in the manual.
Fri, Oct 11, 3:16 AM · Documentation
Brendon Murphy (meta-androcto) added members for Documentation: Vilem Duha (pildanovak), Ivan Cappiello (icappiello).
Fri, Oct 11, 12:29 AM

Wed, Oct 9

Dalai Felinto (dfelinto) updated the task description for T70624: 2.81 Missing Features in Manual.
Wed, Oct 9, 2:17 AM · Documentation, BF Blender (2.81), Development Management
Dalai Felinto (dfelinto) added a comment to T70623: 2.81 Missing Release Log Documentation.

Note: a lot of these features have images/videos in the meeting notes:
https://devtalk.blender.org/c/blender/meeting-notes

Wed, Oct 9, 2:12 AM · Documentation, BF Blender (2.81), Development Management
Dalai Felinto (dfelinto) updated the task description for T70623: 2.81 Missing Release Log Documentation.
Wed, Oct 9, 2:09 AM · Documentation, BF Blender (2.81), Development Management

Tue, Oct 8

Dalai Felinto (dfelinto) removed a project from T70622: 2.81 Missing Documentation: BF Blender (2.81).
Tue, Oct 8, 2:02 AM · Documentation, Development Management
Dalai Felinto (dfelinto) moved T70622: 2.81 Missing Documentation from bcon3: Bugs to bcon2: Features on the BF Blender (2.81) board.
Tue, Oct 8, 2:01 AM · Documentation, Development Management
Dalai Felinto (dfelinto) moved T70623: 2.81 Missing Release Log Documentation from bcon3: Bugs to bcon2: Features on the BF Blender (2.81) board.
Tue, Oct 8, 2:01 AM · Documentation, BF Blender (2.81), Development Management
Dalai Felinto (dfelinto) moved T70624: 2.81 Missing Features in Manual from bcon3: Bugs to bcon2: Features on the BF Blender (2.81) board.
Tue, Oct 8, 2:01 AM · Documentation, BF Blender (2.81), Development Management
Dalai Felinto (dfelinto) triaged T70624: 2.81 Missing Features in Manual as Confirmed, High priority.
Tue, Oct 8, 1:47 AM · Documentation, BF Blender (2.81), Development Management
Dalai Felinto (dfelinto) triaged T70623: 2.81 Missing Release Log Documentation as Confirmed, High priority.
Tue, Oct 8, 1:45 AM · Documentation, BF Blender (2.81), Development Management
Dalai Felinto (dfelinto) changed Type from Bug to To Do on T70622: 2.81 Missing Documentation.
Tue, Oct 8, 1:44 AM · Documentation, Development Management
Dalai Felinto (dfelinto) triaged T70622: 2.81 Missing Documentation as Confirmed, High priority.
Tue, Oct 8, 1:44 AM · Documentation, Development Management

Sun, Oct 6

Matthias Richter (theyseemeblendin) added a comment to T69307: Some lines in .pot-files don't translate to any language.

I don't know what exactly caused this behaviour, but I found a solution:
If you rebuild the pot-file from the corresponding rst-file (I used "make update_po" for this) and use it to create a new po-file, everything works fine. You'll have to manually copy all translated messages to the new po-file though.

Sun, Oct 6, 1:42 AM · Documentation

Sat, Oct 5

Bug Reporter (bugreporter) edited projects for T70553: Creating vertices by hotkey, Documentation says Ctrl-LMB, it's Ctrl-RMB, added: Documentation; removed BF Blender.
Sat, Oct 5, 10:57 AM · Documentation

Wed, Oct 2

Brecht Van Lommel (brecht) added a reviewer for D5971: Document Freestyle Sinus Displacement Phase Cycle: Aaron Carlisle (Blendify).
Wed, Oct 2, 7:03 PM · Documentation
Simon Repp (simonrepp) updated the summary of D5971: Document Freestyle Sinus Displacement Phase Cycle.
Wed, Oct 2, 3:24 PM · Documentation
Simon Repp (simonrepp) created D5971: Document Freestyle Sinus Displacement Phase Cycle.
Wed, Oct 2, 3:23 PM · Documentation

Tue, Oct 1

Brecht Van Lommel (brecht) closed D5721: Corrected description of Cycles' environment baking.
Tue, Oct 1, 8:18 PM · Documentation

Sat, Sep 28

Renato Henriques (Spartacus1) added a comment to T68704: Documentation: explain that Blender 2.80 Exporting a textured OBJ with any shader other than Principled BSDF will result in an MTL without map_Kd pointing to texture file.

It's strange that Blender 2.8 solved most interface annoyances when compared with other 3D packages but keep some that are still unique. I've tested most 3D packages and Blender is the only one that is unable to save a .obj file without textures (even if this option is available in the export as "Export Materials". If we are using an image file we must add manually a mat_kd line with the proper image name after. Come on guys, this is not, by any means. a design choice, it's just clumsy and unique to blender. If I choose in the options to export materials and "copy" option available, the used textures should be copied and the respective mat_kd line added.

Sat, Sep 28, 7:37 PM · Documentation, Import/Export, Add-ons

Wed, Sep 25

Brecht Van Lommel (brecht) added a member for Documentation: Patrick Mours (pmoursnv).
Wed, Sep 25, 12:41 PM

Fri, Sep 20

Germano Cavalcante (mano-wii) lowered the priority of T69628: There's an undocumented nonsensical collections section in the rigid body options (just below the sensitivity settings) from Needs Triage by Developer to Confirmed, Medium.
Fri, Sep 20, 7:55 PM · Documentation, Physics, BF Blender
Antonin (Antoninhs) added a comment to T70105: Transform orientation shortcut wrong in documentation.

There is currently no shortcuts for the 2.7x keymap

Fri, Sep 20, 5:04 PM · Documentation
Philipp Oeser (lichtwerk) removed a project from T70105: Transform orientation shortcut wrong in documentation: BF Blender.
Fri, Sep 20, 2:56 PM · Documentation
Philipp Oeser (lichtwerk) renamed T70105: Transform orientation shortcut wrong in documentation from Transform orientation shortcut wrong in documetation to Transform orientation shortcut wrong in documentation.
Fri, Sep 20, 2:56 PM · Documentation
Philipp Oeser (lichtwerk) renamed T70105: Transform orientation shortcut wrong in documentation from Transform orientation shortcut to Transform orientation shortcut wrong in documetation.
Fri, Sep 20, 2:55 PM · Documentation
Philipp Oeser (lichtwerk) added a comment to T70105: Transform orientation shortcut wrong in documentation.

Shortcut is , now afaict.
The bug assigning the other shortcut is T65397: Assigning shortcut to editor properties gives errors

Fri, Sep 20, 2:55 PM · Documentation
Jacques Lucke (JacquesLucke) added a project to T70105: Transform orientation shortcut wrong in documentation: Documentation.
Fri, Sep 20, 1:33 PM · Documentation

Sep 19 2019

Martin Capitanio (capnm) added a comment to T70041: Rotate around bounding box center poorly documented.

No bbox of the object is ever used, so why show it as such?

Take it as brain training for the new fake-news world. Once you get what it really does, you can simply ignore what it says :-)

Sep 19 2019, 8:43 AM · Documentation
Paul Melis (paulmelis) added a comment to T70041: Rotate around bounding box center poorly documented.

Right, so in object mode and edit mode the behaviour is different (bbox of object centers, versus bbox of selected vertices/edges/faces). So I still think the first picture on that page ("Relationship between an Object and its Bounding Box") is putting readers on the wrong foot. No bbox of the object is ever used, so why show it as such? If it is to explain the concept of a bounding box then showing the bbox of objects centers would make more sense.

Sep 19 2019, 7:33 AM · Documentation
Campbell Barton (campbellbarton) added a comment to T70041: Rotate around bounding box center poorly documented.

While this could work differently this is working as intended.

Sep 19 2019, 1:07 AM · Documentation

Sep 18 2019

Paul Melis (paulmelis) created T70041: Rotate around bounding box center poorly documented.
Sep 18 2019, 10:49 PM · Documentation

Sep 16 2019

Aaron Carlisle (Blendify) added a comment to T68588: Blender: Going Locale.

The only reason is to help do the changes I described but if you would like to stay on top of things instead that works too.

Sep 16 2019, 9:17 PM · Documentation, BF Blender, Translations, Infrastructure: Websites

Sep 14 2019

zdy (NGENNGT) added a member for Documentation: Kinyu Wu (Mr_Kin).
Sep 14 2019, 1:34 AM

Sep 13 2019

Aaron Carlisle (Blendify) assigned T68050: Online Manual / Online Python reference fails for anything related to CyclesRenderSettings to Campbell Barton (campbellbarton).
Sep 13 2019, 8:55 PM · User Interface, Cycles, Python, Documentation, BF Blender
Aaron Carlisle (Blendify) moved T68588: Blender: Going Locale from Backlog to Administrative on the Documentation board.
Sep 13 2019, 8:54 PM · Documentation, BF Blender, Translations, Infrastructure: Websites
Aaron Carlisle (Blendify) moved T68432: Blender Documentation Release Cycle from Backlog to Administrative on the Documentation board.
Sep 13 2019, 8:54 PM · Documentation
zdy (NGENNGT) added projects to T69840: curve handle colors viewport display inconsistent with theme settings: User Interface, Documentation.
Sep 13 2019, 1:49 PM · User Interface, BF Blender

Sep 10 2019

Aaron Carlisle (Blendify) accepted D5721: Corrected description of Cycles' environment baking.
Sep 10 2019, 2:50 PM · Documentation

Sep 9 2019

Brecht Van Lommel (brecht) added a member for Documentation: Omar Emara (OmarSquircleArt).
Sep 9 2019, 5:48 PM
D5721: Corrected description of Cycles' environment baking is now accepted and ready to land.
Sep 9 2019, 4:27 PM · Documentation
Bastien Montagne (mont29) added a comment to D5721: Corrected description of Cycles' environment baking.

Please *DO NOT* put projects as reviewers, this is generating lots of mail noise for lost of people!

Sep 9 2019, 2:07 PM · Documentation