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

zdy (NGENNGT) edited projects for D5328: Finish the topbar.po, added: Documentation; removed Translations.

Reviewed and accepted.
@Robert Zhang (zhruith) I think you need a commit access to make the contribution easier.
@Aaron Carlisle (Blendify) Please help add the access.

Wed, Jul 24, 5:56 AM · Documentation
zdy (NGENNGT) edited projects for D5330: Finish the status_bar.po, added: Documentation; removed Translations.

Reviewed and Accepted.

Wed, Jul 24, 5:46 AM · Documentation

Yesterday

Julian Eisel (Severin) updated the task description for T55366: Blender development todo list -- Editors.
Tue, Jul 23, 1:11 PM · Documentation

Mon, Jul 22

Aaron Carlisle (Blendify) updated the task description for T65710: Blender 2.8 Manual Sprint.
Mon, Jul 22, 11:22 PM · BF Blender, Documentation
Alistair Buxton (ali1234) added a comment to T57691: Bevel Clamp Overlap affects all beveled edges in mesh, contrary to documentation.

Indeed, the other file was fixed in https://developer.blender.org/rBM5386#change-VMAUOvkfNSTh

Mon, Jul 22, 3:16 PM · Documentation
Vyacheslav (hitrpr) added a comment to T51302: "Boid" Force field does nothing; should be removed.

@Aaron Carlisle (Blendify)
I found this scene before I post here.
It just crashes my 2.79 or 2.80, and append crush it too
It made with 2.49

Mon, Jul 22, 2:22 PM · Documentation, Physics, BF Blender
Howard Trickey (howardt) added a comment to T57691: Bevel Clamp Overlap affects all beveled edges in mesh, contrary to documentation.

Thanks, fixed. (I only found one instance, in the modifier page. Maybe you fixed the other?)

Mon, Jul 22, 12:58 PM · Documentation
Brendon Murphy (meta-androcto) added a comment to T54097: Proposal: Addon documentation for 2.8.

@Inês Almeida (brita_)
I'm not a fan of bundling rst docs with addons, the simple way to do this would be to add the doc information to the addons preferences panel within the addon.
That said, It's not an optimal solution and would not provide comprehensive docs that is more focused in high level presentation.
We had designed the wiki catalog with many nice features like documentation progress and templates.
If we can all come to agree I'll start work shortly on this.

Mon, Jul 22, 5:44 AM · Documentation, Addons
Aaron Carlisle (Blendify) added a comment to T51302: "Boid" Force field does nothing; should be removed.

https://blenderartists.org/t/boid-attractor-deflector-example-scene/462643

Mon, Jul 22, 3:03 AM · Documentation, Physics, BF Blender
Alistair Buxton (ali1234) updated subscribers of T57691: Bevel Clamp Overlap affects all beveled edges in mesh, contrary to documentation.

@Aaron Carlisle (Blendify) nitpick, but in that commit you introduced a grammar error: "edges cannot causes overlapping" should be "edges cannot cause overlapping". There are two instances of this phrase.

Mon, Jul 22, 3:02 AM · Documentation
Aaron Carlisle (Blendify) added a project to T51302: "Boid" Force field does nothing; should be removed: Documentation.
Mon, Jul 22, 2:46 AM · Documentation, Physics, BF Blender
Aaron Carlisle (Blendify) closed T55018: Documentation for 2.8 (WIP) as Resolved.
Mon, Jul 22, 2:38 AM · BF Blender, Documentation
Aaron Carlisle (Blendify) closed T57016: 2.8 Physics docs (Parent task), a subtask of T55018: Documentation for 2.8 (WIP), as Resolved.
Mon, Jul 22, 2:38 AM · BF Blender, Documentation
Aaron Carlisle (Blendify) closed T57016: 2.8 Physics docs (Parent task) as Resolved.
Mon, Jul 22, 2:38 AM · Documentation
Aaron Carlisle (Blendify) closed T57032: Cloth: Componentize forces, a subtask of T57016: 2.8 Physics docs (Parent task), as Resolved.
Mon, Jul 22, 2:38 AM · Documentation
Aaron Carlisle (Blendify) closed T57032: Cloth: Componentize forces as Resolved.
Mon, Jul 22, 2:38 AM · Documentation

Sun, Jul 21

Aaron Carlisle (Blendify) closed T57017: Cloth: Collision improvements as Resolved by committing rBM5584: Cloth: Collision improvements (2.80).
Sun, Jul 21, 11:34 PM · Documentation
Aaron Carlisle (Blendify) closed T57017: Cloth: Collision improvements, a subtask of T57016: 2.8 Physics docs (Parent task), as Resolved.
Sun, Jul 21, 11:34 PM · Documentation
Aaron Carlisle (Blendify) edited Description on Documentation.
Sun, Jul 21, 11:12 PM
Aaron Carlisle (Blendify) added members for Documentation: Yuan (tuzkie), qiancheng lin (lqc).
Sun, Jul 21, 11:12 PM
Bastien Montagne (mont29) updated the task description for T65710: Blender 2.8 Manual Sprint.
Sun, Jul 21, 11:11 PM · BF Blender, Documentation
Aaron Carlisle (Blendify) moved T67387: Please describe how to make add-on development more efficent (e.g. reloading) from Backlog to Improve documentation on the Documentation board.
Sun, Jul 21, 10:38 PM · Documentation
Aaron Carlisle (Blendify) closed T57449: 2.8: Animation (Parent Task), a subtask of T55018: Documentation for 2.8 (WIP), as Resolved.
Sun, Jul 21, 10:37 PM · BF Blender, Documentation
Aaron Carlisle (Blendify) closed T57449: 2.8: Animation (Parent Task) as Resolved.
Sun, Jul 21, 10:37 PM · Documentation
Aaron Carlisle (Blendify) closed T57450: Improved driver workflow, a subtask of T57449: 2.8: Animation (Parent Task), as Resolved.
Sun, Jul 21, 10:35 PM · Documentation
Aaron Carlisle (Blendify) updated subscribers of T57450: Improved driver workflow.

Thanks @Inês Almeida (brita_) for woking on this.

Sun, Jul 21, 10:35 PM · Documentation
Inês Almeida (brita_) updated the task description for T65710: Blender 2.8 Manual Sprint.
Sun, Jul 21, 10:21 PM · BF Blender, Documentation
Aaron Carlisle (Blendify) closed T57446: Cycles: Voronoi: features and distance as Resolved by committing rBM5580: Cycles: Expand Voronoi Texture.
Sun, Jul 21, 10:06 PM · Documentation
Iemand Iets (NumesSanguis) renamed T67387: Please describe how to make add-on development more efficent (e.g. reloading) from Please describe how to make add-on development more efficent to Please describe how to make add-on development more efficent (e.g. reloading).
Sun, Jul 21, 4:35 PM · Documentation
Iemand Iets (NumesSanguis) updated the task description for T67387: Please describe how to make add-on development more efficent (e.g. reloading).
Sun, Jul 21, 4:28 PM · Documentation
Iemand Iets (NumesSanguis) created T67387: Please describe how to make add-on development more efficent (e.g. reloading).
Sun, Jul 21, 4:03 PM · Documentation

Sat, Jul 20

Robert Guetzkow (rjg) added a comment to T65710: Blender 2.8 Manual Sprint.
Sat, Jul 20, 2:24 PM · BF Blender, Documentation
Robert Guetzkow (rjg) added a comment to T65710: Blender 2.8 Manual Sprint.
Sat, Jul 20, 2:08 PM · BF Blender, Documentation
Inês Almeida (brita_) added a comment to T54097: Proposal: Addon documentation for 2.8.

I don't think there should be any user documentation in the development wiki.
The wiki is for developers, the manual for users. I think the documentation for all types of add-ons should be together and in the manual.

Sat, Jul 20, 12:45 PM · Documentation, Addons
Brendon Murphy (meta-androcto) added a comment to T54097: Proposal: Addon documentation for 2.8.

hi, I would like to add that we could/can do this:
Official addons only to have Manual Pages, there could be exceptions to this, but I think it's a good general rule.
Community Addons to have direct link wiki pages as was the previous behavior. 1 Main "Catalog" page with the current and updated list of addons included in Release only.
We first started this system of addons documentation in the 2.4 series, rebuilt and improved for 2.5/6 series. At the end of the day, https://archive.blender.org/wiki/index.php/Extensions:2.6/Py/Scripts/ was one of the most popular wiki pages visited. I think we could continue with this for 2.8 series. Only devs with commit status would be allowed to edit the wiki after gaining permissions. There's plenty of good sites listing and documenting external addons already.

Sat, Jul 20, 4:31 AM · Documentation, Addons
Aaron Carlisle (Blendify) updated the task description for T65710: Blender 2.8 Manual Sprint.
Sat, Jul 20, 12:43 AM · BF Blender, Documentation

Fri, Jul 19

Francesco Siddi (fsiddi) added a comment to T54097: Proposal: Addon documentation for 2.8.

Ok, thanks for the clarification. So I assume I'm going to place the add-on docs in manual/addons/.
Is any action required in order to close this issue then?
Do you need any help communicating to all core add-ons developers that documentation should be migrated to the manual?

Fri, Jul 19, 9:52 PM · Documentation, Addons
Brecht Van Lommel (brecht) added a comment to T54097: Proposal: Addon documentation for 2.8.

The decision was to document add-ons in the Blender manual, not the wiki.

Fri, Jul 19, 9:40 PM · Documentation, Addons
Francesco Siddi (fsiddi) updated subscribers of T54097: Proposal: Addon documentation for 2.8.

As we are approaching Blender 2.80 release, I'd like to get final confirmation that for the time being add-ons shipped with Blender will be documented on the Blender Wiki. Personally, I want to make sure that the presentation of Blender ID and Blender Cloud add-ons is sufficiently polished and up-to-date.

Fri, Jul 19, 9:38 PM · Documentation, Addons

Wed, Jul 17

Aaron Carlisle (Blendify) updated the task description for T65710: Blender 2.8 Manual Sprint.
Wed, Jul 17, 4:31 AM · BF Blender, Documentation
Aaron Carlisle (Blendify) added a comment to D5261: Update glTF add-on documentation.

Yeah, I forgot to accept the changes. The close option should appear otherwise. You can also add Differential Revision: https://developer.blender.org/D5261 in the message of the commit and this will automatically close this.

Wed, Jul 17, 4:01 AM · Documentation
Aaron Carlisle (Blendify) closed D5261: Update glTF add-on documentation.
Wed, Jul 17, 4:00 AM · Documentation
D5261: Update glTF add-on documentation is now accepted and ready to land.
Wed, Jul 17, 3:59 AM · Documentation
Ed Mackey (emackey) added a comment to D5261: Update glTF add-on documentation.

I'm new to Differential. Is there an extra step to close this out now that it's been committed?

Wed, Jul 17, 3:46 AM · Documentation
Ed Mackey (emackey) added a comment to D5261: Update glTF add-on documentation.

Comitted in https://developer.blender.org/rBM5545

Wed, Jul 17, 3:36 AM · Documentation
Aaron Carlisle (Blendify) added a comment to D5261: Update glTF add-on documentation.

You should now have commit access. The login credentials get synced with this website.

Wed, Jul 17, 2:37 AM · Documentation
Aaron Carlisle (Blendify) added a member for Documentation: Ed Mackey (emackey).
Wed, Jul 17, 2:36 AM
Ed Mackey (emackey) added a comment to D5261: Update glTF add-on documentation.

That would be great, thanks!

Wed, Jul 17, 2:03 AM · Documentation
Aaron Carlisle (Blendify) added a comment to D5261: Update glTF add-on documentation.

Looks good to me, would you like to commit, I can give you commit access.

Wed, Jul 17, 1:35 AM · Documentation

Tue, Jul 16

Ed Mackey (emackey) added a comment to D5261: Update glTF add-on documentation.

Thanks for the review. I made the changes to the wording, and here are the updated images:

Tue, Jul 16, 3:46 PM · Documentation