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

Yesterday

Germano Cavalcante (mano-wii) changed the status of T78553: "Straighten" operator doesn't always work and isn't well documented in the manual. from Needs Triage to Confirmed.
Wed, Jul 8, 11:15 PM · Restricted Project, Images & Movies, Documentation, BF Blender
Alaska (Alaska) closed T78734: Typo in Blender Manual as Resolved by committing rBM6866: Fix T78734: Incorrect link in toolbar for cloth brush.
Wed, Jul 8, 1:00 PM · Documentation
Alaska (Alaska) updated subscribers of T78734: Typo in Blender Manual.
Wed, Jul 8, 12:53 PM · Documentation
Alaska (Alaska) claimed T78734: Typo in Blender Manual.
Wed, Jul 8, 12:52 PM · Documentation
Kurt Matson (kurt.matson) added a comment to T78734: Typo in Blender Manual.

name

Wed, Jul 8, 12:06 PM · Documentation
Kurt Matson (kurt.matson) created T78734: Typo in Blender Manual.
Wed, Jul 8, 12:03 PM · Documentation
Richard Antalik (ISS) renamed T78557: UV editor Align operator is unintuitive from UV editor's Align operator says the wrong axis. to UV editor Align operator is unintuitive.
Wed, Jul 8, 1:29 AM · User Interface, Documentation, BF Blender
Richard Antalik (ISS) added a comment to T78557: UV editor Align operator is unintuitive.

As person unfamiliar with this feature I really can't tell what is it's intended funcionality and purpose from documentation, so I guess I will go ahead and conirm this.

Wed, Jul 8, 1:26 AM · User Interface, Documentation, BF Blender

Tue, Jul 7

Gilberto Rodrigues (gilberto_rodrigues) added a comment to T78553: "Straighten" operator doesn't always work and isn't well documented in the manual. .

yea, the description isn't true

Tue, Jul 7, 5:07 PM · Restricted Project, Images & Movies, Documentation, BF Blender
Germano Cavalcante (mano-wii) added projects to T78553: "Straighten" operator doesn't always work and isn't well documented in the manual. : Documentation, Images & Movies, Restricted Project.

It's description is: "Align UVs along the line defined by the endpoints".
Apparently you need to have a sequence of points selected in order to have endpoints.
I agree that this description needs to be improved.

Tue, Jul 7, 3:16 PM · Restricted Project, Images & Movies, Documentation, BF Blender
Aaron Carlisle (Blendify) updated the task description for T76164: 2.90 Documentation.
Tue, Jul 7, 3:31 AM · BF Blender (2.90), Development Management, Documentation

Sun, Jul 5

Aaron Carlisle (Blendify) closed D8143: Hair BSDF Shader Examples (ToDo <2.8).
Sun, Jul 5, 8:41 PM · Nodes, Documentation, BF Blender (2.82)

Fri, Jul 3

Aaron Carlisle (Blendify) reopened T78540: Knife Selection tool inaccessible through keyboard shortcut as "Needs Triage".

didnt mean to close this...

Fri, Jul 3, 6:23 PM · Documentation, User Interface, BF Blender
Gilberto Rodrigues (gilberto_rodrigues) added a comment to T78557: UV editor Align operator is unintuitive.

Align - to put two or more things into a straight line.
The operator says "Align UVs on X axis". So it would means to put things on the X axis in a straight line. That's not what it does.
The X axis is horizontal. But the operator will align in a vertical line, but that's not the Y axis either, because it's not centered, it puts in a line of the average X coordinate.
The problem is not the word Align, it's how it was used. Align on X should renamed to "Align vertically" and Align on Y should be renamed to "Align horizontally".

Fri, Jul 3, 12:50 PM · User Interface, Documentation, BF Blender
Germano Cavalcante (mano-wii) added projects to T78557: UV editor Align operator is unintuitive: Documentation, User Interface.

I wouldn't say this is a bug. But I agree that the name is a little confusing.

Fri, Jul 3, 3:29 AM · User Interface, Documentation, BF Blender
Aaron Carlisle (Blendify) added a comment to T78540: Knife Selection tool inaccessible through keyboard shortcut.

I updated the manual to reflect the current state in: rBM6847

Fri, Jul 3, 1:52 AM · Documentation, User Interface, BF Blender
Aaron Carlisle (Blendify) added a project to T78540: Knife Selection tool inaccessible through keyboard shortcut: Documentation.
Fri, Jul 3, 1:34 AM · Documentation, User Interface, BF Blender
Mateusz Grzeliński (grzelins) added a comment to D8184: Changing key shown in manual..

There's an issue with the keymap. The Shift-K should be returned as in 27X, there is no other way to call "Only Selected".

Actually it is exposed in active tool settings. You will find there Occlude Geometry and Only Selected. Most of the setting for this operator are in the bottom status bar as this is modal operator that is why it is confusing on first look...

Fri, Jul 3, 12:16 AM · Documentation, Modeling

Thu, Jul 2

Aaron Carlisle (Blendify) reopened T78540: Knife Selection tool inaccessible through keyboard shortcut as "Needs Triage".
Thu, Jul 2, 11:09 PM · Documentation, User Interface, BF Blender
Sundaram Ramaswamy (legends2k) added a comment to T78540: Knife Selection tool inaccessible through keyboard shortcut.

@Aaron Carlisle (Blendify) How do I reopen this issue? This seems to have been erroneously resolved.

Thu, Jul 2, 10:50 PM · Documentation, User Interface, BF Blender
Yevgeny Makarov (jenkm) updated subscribers of D8184: Changing key shown in manual..

This is wrong. "Knife Selection" (only selected faces are cut) not called by K key.
The K call "Knife" without Only Selected option.

Thu, Jul 2, 10:17 PM · Documentation, Modeling
Sundaram Ramaswamy (legends2k) updated subscribers of T78540: Knife Selection tool inaccessible through keyboard shortcut.
Thu, Jul 2, 10:04 PM · Documentation, User Interface, BF Blender
Sundaram Ramaswamy (legends2k) added a comment to T78540: Knife Selection tool inaccessible through keyboard shortcut.

The keyboard shortcut is K, not shift+K. The docs do appear to be wrong.

Thu, Jul 2, 10:00 PM · Documentation, User Interface, BF Blender
Aaron Carlisle (Blendify) changed the status of T78540: Knife Selection tool inaccessible through keyboard shortcut from Invalid to Resolved by committing rBM6846: Modeling: Fix Knife shortcut.
Thu, Jul 2, 9:59 PM · Documentation, User Interface, BF Blender
Aaron Carlisle (Blendify) closed D8184: Changing key shown in manual..
Thu, Jul 2, 9:59 PM · Documentation, Modeling
Sharath (sharaths21312) updated the diff for D8184: Changing key shown in manual..

Small cleanup.

Thu, Jul 2, 6:41 PM · Documentation, Modeling
Sharath (sharaths21312) edited projects for T78540: Knife Selection tool inaccessible through keyboard shortcut, added: Documentation; removed BF Blender.
Thu, Jul 2, 5:47 PM · Documentation, User Interface, BF Blender

Wed, Jul 1

Erik (Enceptus) added a comment to T78385: Docs: [Edit Page] doesn't let me edit page.

Currently, there is no mechanism to edit online, however our goal with link here is to direct users towards are development portal instead of just linking to raw source files.

Wed, Jul 1, 9:46 PM · Documentation, BF Blender
Clément Foucault (fclem) updated the task description for T55363: Blender development todo list -- Render.
Wed, Jul 1, 6:37 PM · Render & Cycles, Freestyle, Cycles, Rendering, Documentation
Aaron Carlisle (Blendify) updated the task description for T76164: 2.90 Documentation.
Wed, Jul 1, 12:56 AM · BF Blender (2.90), Development Management, Documentation

Tue, Jun 30

Aaron Carlisle (Blendify) updated the task description for T76164: 2.90 Documentation.
Tue, Jun 30, 11:56 PM · BF Blender (2.90), Development Management, Documentation
Aaron Carlisle (Blendify) updated the task description for T76164: 2.90 Documentation.
Tue, Jun 30, 10:03 PM · BF Blender (2.90), Development Management, Documentation
Aaron Carlisle (Blendify) triaged T73319: New File Browser Docs as High priority.
Tue, Jun 30, 6:43 PM · Documentation
Aaron Carlisle (Blendify) updated the task description for T76164: 2.90 Documentation.
Tue, Jun 30, 6:42 PM · BF Blender (2.90), Development Management, Documentation
Aaron Carlisle (Blendify) updated the task description for T76164: 2.90 Documentation.
Tue, Jun 30, 6:36 PM · BF Blender (2.90), Development Management, Documentation
Aaron Carlisle (Blendify) updated the task description for T76164: 2.90 Documentation.
Tue, Jun 30, 6:31 PM · BF Blender (2.90), Development Management, Documentation
Aaron Carlisle (Blendify) changed the subtype of T78450: Missing documentation in "Extrude Faces Along Normals" page from "Report" to "To Do".
Tue, Jun 30, 6:22 PM · Documentation
Simon Holmes Udovic (zircad) added a comment to T78450: Missing documentation in "Extrude Faces Along Normals" page.

Its grouped under extrude tool, you can click and hold on the tool to show the menu

Tue, Jun 30, 5:16 PM · Documentation
Rahul Chaudhary (RC12) added a comment to T78450: Missing documentation in "Extrude Faces Along Normals" page.

Its grouped under extrude tool, you can click and hold on the tool to show the menu

Tue, Jun 30, 5:40 AM · Documentation
Alaska (Alaska) renamed T78450: Missing documentation in "Extrude Faces Along Normals" page from Where is the extrude along normals? in the manual only said "Todo" to Missing documentation in "Extrude Faces Along Normals" page.
Tue, Jun 30, 5:38 AM · Documentation
Alaska (Alaska) changed the status of T78450: Missing documentation in "Extrude Faces Along Normals" page from Needs Triage to Confirmed.

It's just not done yet.

Tue, Jun 30, 5:37 AM · Documentation
Simon Holmes Udovic (zircad) updated the task description for T78450: Missing documentation in "Extrude Faces Along Normals" page.
Tue, Jun 30, 5:06 AM · Documentation
Simon Holmes Udovic (zircad) created T78450: Missing documentation in "Extrude Faces Along Normals" page.
Tue, Jun 30, 5:03 AM · Documentation

Mon, Jun 29

Aaron Carlisle (Blendify) closed D8140: add render page introduction. (japanese manual ).
Mon, Jun 29, 10:58 PM · Documentation
Kenneth Y (Microbob) added a comment to T78342: Snap installation information missing from manual.

hmm, I see. I didn't know that 👍

Mon, Jun 29, 10:58 PM · Good First Issue, Documentation
Aaron Carlisle (Blendify) added a comment to T78342: Snap installation information missing from manual.

I made a change in rBM6830. I want to include this information as snap is a little different than a package manager. The builds are also made by Blender and are more consistent with the official blender.org downloads.

Mon, Jun 29, 10:53 PM · Good First Issue, Documentation
Aaron Carlisle (Blendify) closed T78403: nomenclature in Particle system dox -- needs updating as Resolved by committing rBM6829: Fix T78403: Wrong Panel Name Referenced.
Mon, Jun 29, 10:34 PM · Documentation
Aaron Carlisle (Blendify) abandoned D8155: My german translation.

Please follow the translation guide:

Mon, Jun 29, 10:17 PM · Documentation
Bastien Montagne (mont29) removed a reviewer for D8155: My german translation: Translations.
Mon, Jun 29, 8:33 PM · Documentation

Sun, Jun 28

Aaron Carlisle (Blendify) changed the status of T78403: nomenclature in Particle system dox -- needs updating from Needs Triage to Confirmed.
Sun, Jun 28, 11:27 PM · Documentation