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

Yevgeny Makarov (jenkm) closed T55270: Duplication of Mirror Vertex Group description as Resolved.
Sun, Aug 18, 3:18 PM · Documentation
Yevgeny Makarov (jenkm) closed T51302: "Boid" Force field does nothing; should be removed as Resolved.
Sun, Aug 18, 3:18 PM · Documentation, Physics, BF Blender
D5515: Update Outliner editor is now accepted and ready to land.

I've added you to the Documentation project to commit this yourself. Username and password is the same as developer.blender.org.

Sun, Aug 18, 3:50 AM · Documentation
Brecht Van Lommel (brecht) added a member for Documentation: Nathan Craddock (Zachman).
Sun, Aug 18, 3:44 AM
Nathan Craddock (Zachman) added a project to D5515: Update Outliner editor: Documentation.
Sun, Aug 18, 12:58 AM · Documentation

Yesterday

Aaron Carlisle (Blendify) added a member for Documentation: Jens Arnold (j.a-b).
Sat, Aug 17, 12:03 AM
Aaron Carlisle (Blendify) 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.

@Philipp Oeser (lichtwerk) you now have commit rights.

Sat, Aug 17, 12:02 AM · Documentation, Import/Export, Add-ons
Aaron Carlisle (Blendify) added a member for Documentation: Philipp Oeser (lichtwerk).
Sat, Aug 17, 12:01 AM

Fri, Aug 16

Aaron Carlisle (Blendify) moved T68738: Text Editor (Missing Documentation) from Backlog to Missing documentation on the Documentation board.
Fri, Aug 16, 11:59 PM · Documentation
Aaron Carlisle (Blendify) moved T68709: Missing Gizmo information in the API documentation from Backlog to Python API on the Documentation board.
Fri, Aug 16, 11:55 PM · Documentation
Yevgeny Makarov (jenkm) created T68738: Text Editor (Missing Documentation).
Fri, Aug 16, 5:01 PM · Documentation
Bastien Montagne (mont29) 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 is plainly impossible to export any kind of node-based shading system into a fixed-pipeline thing like MTL or FBX formats suport. That’s just basic common sense. We can only offer some very limited approximation in some well-defined cases. Note that 2.7x did not export node-based materials at all.

Fri, Aug 16, 4:33 PM · Documentation, Import/Export, Add-ons
Luke Meeken (lmeeken) 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.

If it is a(n undocumented) design choice, it is different from the design choice in 2.7 versions of Blender, which exported a usable .mtl . It also feels like an ill-advised design choice as it depends on a workaround outside of the program itself (manually adding the map_Kt line to the mtl in a text editor) to "remedy."

Fri, Aug 16, 3:45 PM · Documentation, Import/Export, Add-ons
Yevgeny Makarov (jenkm) added a revision to T55270: Duplication of Mirror Vertex Group description: D5502: Documentation: Mirror Vertex Group.
Fri, Aug 16, 3:04 PM · Documentation
Bastien Montagne (mont29) closed 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 Resolved by committing rBM5715: Fix T68704: Add info about material wrapper for IO addons..
Fri, Aug 16, 11:44 AM · Documentation, Import/Export, Add-ons
Philipp Oeser (lichtwerk) renamed 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 from Blender 2.80 Exporting a textured OBJ with any shader other than Principled BSDF results in an MTL without map_Kd pointing to texture file to 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.
Fri, Aug 16, 9:53 AM · Documentation, Import/Export, Add-ons
Philipp Oeser (lichtwerk) edited projects for 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, added: Add-ons, Import/Export, Documentation; removed BF Blender.

This is a design choice, yes.

Fri, Aug 16, 9:52 AM · Documentation, Import/Export, Add-ons

Thu, Aug 15

Cédric (Clarkx) created T68709: Missing Gizmo information in the API documentation.
Thu, Aug 15, 10:29 PM · Documentation
Campbell Barton (campbellbarton) closed T68688: Manual shortcut typo for chapter: Sculpting & Painting » Brush » Stroke » Curve Add Points as Resolved by committing rBM5710: Fix T68688: Manual shortcut typo for Sculpting & Painting > Brush > Stroke >….
Thu, Aug 15, 1:37 PM · Documentation
Christoph Werner (Taros) created T68688: Manual shortcut typo for chapter: Sculpting & Painting » Brush » Stroke » Curve Add Points.
Thu, Aug 15, 12:30 PM · Documentation

Wed, Aug 14

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

user registration - possible to use phabricator user database? Or some other way to keep these in sync?

Wed, Aug 14, 11:52 PM · Documentation, BF Blender, Translations, Infrastructure: Websites
Aaron Carlisle (Blendify) updated the task description for T68588: Blender: Going Locale.
Wed, Aug 14, 10:54 PM · Documentation, BF Blender, Translations, Infrastructure: Websites
Brecht Van Lommel (brecht) added a comment to D5330: Finish the status_bar.po.

I'm closing all these translation reviews, which I believe have been committed.

Wed, Aug 14, 12:04 PM · Documentation
Nathan Letwory (jesterking) updated subscribers of T68588: Blender: Going Locale.

[..] translation review [..]

Wed, Aug 14, 10:52 AM · Documentation, BF Blender, Translations, Infrastructure: Websites
zdy (NGENNGT) added a comment to T68588: Blender: Going Locale.

In my opinion, there are three requirements for new translators:

Wed, Aug 14, 1:46 AM · Documentation, BF Blender, Translations, Infrastructure: Websites
Aaron Carlisle (Blendify) updated subscribers of T68588: Blender: Going Locale.

In a discussion with @zdy (NGENNGT) in #docs on blender.chat one issue with the manual translations is the lack of quality of translations due to translators need to know proper RST formatting to translate po files.
Because moving to such a system that is online, translators will not be building docs locally and there is concern that the amount of formatting errors would increase.

Wed, Aug 14, 1:42 AM · Documentation, BF Blender, Translations, Infrastructure: Websites
Aaron Carlisle (Blendify) added a member for Documentation: Masayuki Osaka (oimo1979).
Wed, Aug 14, 1:25 AM

Tue, Aug 13

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

@Gabriel Gazzán (gab3d) Thank you for the response, part of my goal here is to get feedback from current translators.

Tue, Aug 13, 11:21 PM · Documentation, BF Blender, Translations, Infrastructure: Websites
Bastien Montagne (mont29) added a comment to T68588: Blender: Going Locale.

Note that you cannot really get rid of the svn repo for Blender UI translations, as those stored in GIT are fully stripped to be as small as possible, they are essentially useless as working translation material...

Tue, Aug 13, 3:24 PM · Documentation, BF Blender, Translations, Infrastructure: Websites
Christopher Anderssarian (Christopher_Anderssarian) added a comment to T68588: Blender: Going Locale.

What's the scope of this? Everything on the blender.org domain (store, cloud, dev wiki, ect...), something in between or just the Blender UI and Manual (for now)?

Tue, Aug 13, 12:51 PM · Documentation, BF Blender, Translations, Infrastructure: Websites
Gabriel Gazzán (gab3d) added a comment to T68588: Blender: Going Locale.

Hi @Aaron Carlisle (Blendify) ,
I'm the translator of the UI into Spanish (one of the few languages that has been consistently maintained throughout these years), I've handed it alone since 2011, and a couple of times people tried to jump onboard to help, but unfortunately they ultimately never did any significant contribution, for different reasons I think.
I understand what you are looking for with these changes, and it could be a good thing, if done properly.

Tue, Aug 13, 12:44 AM · Documentation, BF Blender, Translations, Infrastructure: Websites

Mon, Aug 12

Aaron Carlisle (Blendify) created T68588: Blender: Going Locale.
Mon, Aug 12, 11:33 PM · Documentation, BF Blender, Translations, Infrastructure: Websites
Aaron Carlisle (Blendify) added a comment to T68432: Blender Documentation Release Cycle.

I think this makes the stages too specific. I would aim for the minimum amount of restrictions you can have, keeping just the ones that serve an important purpose.

Mon, Aug 12, 9:34 PM · Documentation
Brecht Van Lommel (brecht) added a comment to T68432: Blender Documentation Release Cycle.

I think this makes the stages too specific. I would aim for the minimum amount of restrictions you can have, keeping just the ones that serve an important purpose.

Mon, Aug 12, 11:56 AM · Documentation

Fri, Aug 9

Dealga McArdle (zeffii) added a comment to T68413: b28 shader module example in docs produces unexpected results.

thank you @Germano Cavalcante (mano-wii) !

Fri, Aug 9, 1:06 PM · Documentation, BF Blender
Aaron Carlisle (Blendify) added a comment to T68432: Blender Documentation Release Cycle.

The goal of this task is to make comments on my proposed process and work on implementing this into the documentation workflow along with the Blender development process.

Fri, Aug 9, 1:48 AM · Documentation
Aaron Carlisle (Blendify) created T68432: Blender Documentation Release Cycle.
Fri, Aug 9, 1:00 AM · Documentation
Aaron Carlisle (Blendify) moved T68413: b28 shader module example in docs produces unexpected results from Improve documentation to Python API on the Documentation board.
Fri, Aug 9, 12:26 AM · Documentation, BF Blender
Aaron Carlisle (Blendify) moved T68413: b28 shader module example in docs produces unexpected results from Backlog to Improve documentation on the Documentation board.
Fri, Aug 9, 12:26 AM · Documentation, BF Blender

Thu, Aug 8

Germano Cavalcante (mano-wii) added a comment to T68413: b28 shader module example in docs produces unexpected results.

In fact something has changed in the meantime and now you need to enable depth testing before drawing...

bgl.glEnable(bgl.GL_DEPTH_TEST)
Thu, Aug 8, 8:31 PM · Documentation, BF Blender
Dealga McArdle (zeffii) added a project to T68413: b28 shader module example in docs produces unexpected results: Documentation.
Thu, Aug 8, 7:54 PM · Documentation, BF Blender

Wed, Aug 7

Aaron Carlisle (Blendify) moved T67188: Write Documentation for the EEVEE Preview shading mode from Backlog to Next Release (2.81) on the Documentation board.
Wed, Aug 7, 11:26 PM · Documentation, BF Blender
Aaron Carlisle (Blendify) added a project to T67188: Write Documentation for the EEVEE Preview shading mode: Documentation.
Wed, Aug 7, 11:25 PM · Documentation, BF Blender
Aaron Carlisle (Blendify) closed T68371: Blender 2.80 Python API - Wrong info on first page: Quickstart Introduction as Resolved by committing rB5e77fb24822b: API Docs: Correct Hotkey.
Wed, Aug 7, 11:21 PM · Documentation
Christophe Swolfs (aschere) created T68371: Blender 2.80 Python API - Wrong info on first page: Quickstart Introduction.
Wed, Aug 7, 4:35 PM · Documentation
Jacques Lucke (JacquesLucke) added a comment to T67387: Please describe how to make add-on development more efficent (e.g. reloading).

Just a quick note, addon reloading can also be done differently. This Visual Studio code extension does the reloading automatically: https://marketplace.visualstudio.com/items?itemName=JacquesLucke.blender-development

Wed, Aug 7, 2:12 PM · Documentation

Tue, Aug 6

Aaron Carlisle (Blendify) added a comment to T55270: Duplication of Mirror Vertex Group description.

Thanks will have a look later.

Tue, Aug 6, 11:09 PM · Documentation
Yevgeny Makarov (jenkm) updated subscribers of T55270: Duplication of Mirror Vertex Group description.

@Aaron Carlisle (Blendify)

Tue, Aug 6, 12:57 PM · Documentation
Yevgeny Makarov (jenkm) added a revision to T51302: "Boid" Force field does nothing; should be removed: D5419: Documentation: Update boids force field.
Tue, Aug 6, 7:18 AM · Documentation, Physics, BF Blender

Mon, Aug 5

Aaron Carlisle (Blendify) added a comment to T51302: "Boid" Force field does nothing; should be removed.

Thank you so much! I will look at these later today.

Mon, Aug 5, 8:44 PM · Documentation, Physics, BF Blender