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

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

Yesterday

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

Mon, Jul 15

D5261: Update glTF add-on documentation now requires changes to proceed.
Mon, Jul 15, 10:37 PM · Documentation
Aaron Carlisle (Blendify) added a comment to D5261: Update glTF add-on documentation.

Regarding images we use a yellow box to markup images if needed, see https://docs.blender.org/manual/en/dev/interface/window_system/workspaces.html for example.

Mon, Jul 15, 10:37 PM · Documentation
Aaron Carlisle (Blendify) added reviewers for D5261: Update glTF add-on documentation: Aaron Carlisle (Blendify), Julien DUROURE (julien).
Mon, Jul 15, 10:21 PM · Documentation
Aaron Carlisle (Blendify) updated the task description for T65710: Blender 2.8 Manual Sprint.
Mon, Jul 15, 10:18 PM · BF Blender, Documentation
Spivak Vladimir (cwolf3d) added a watcher for Documentation: Spivak Vladimir (cwolf3d).
Mon, Jul 15, 7:55 PM
Ed Mackey (emackey) created D5261: Update glTF add-on documentation.
Mon, Jul 15, 3:58 PM · Documentation

Sun, Jul 14

Aaron Carlisle (Blendify) updated the task description for T65710: Blender 2.8 Manual Sprint.
Sun, Jul 14, 8:24 PM · BF Blender, Documentation
Sergey (koloved) added a comment to D5170: 5 pages to Russian.patch.

@Aaron Carlisle (Blendify)
I cannot send it directly to SVN cause my log and password , i am trying few times by UI and console

Sun, Jul 14, 7:39 AM · Documentation
Sergey (koloved) added a comment to D5168: Translate two modifier to Russian Patch.

I lost these 2 files, i cant commit it , sorry

Sun, Jul 14, 7:28 AM · Documentation
Aaron Carlisle (Blendify) added a member for Documentation: Rei Tatsumi (tatmius).
Sun, Jul 14, 2:24 AM
Aaron Carlisle (Blendify) edited Description on Documentation.
Sun, Jul 14, 2:23 AM
Aaron Carlisle (Blendify) added a comment to D5168: Translate two modifier to Russian Patch.

@Sergey (koloved) I gave you commit access to the translations repository. Please commit this and any other patch directly to svn.
The username and passwords are synced with this website.

Sun, Jul 14, 2:19 AM · Documentation
Aaron Carlisle (Blendify) added a comment to D5170: 5 pages to Russian.patch.

@Sergey (koloved) I gave you commit access to the translations repository. Please commit this and any other patch directly to svn.
The username and passwords are synced with this website.

Sun, Jul 14, 2:19 AM · Documentation
Aaron Carlisle (Blendify) added a member for Documentation: Sergey (koloved).
Sun, Jul 14, 2:17 AM
Aaron Carlisle (Blendify) edited Description on Documentation.
Sun, Jul 14, 2:17 AM
Aaron Carlisle (Blendify) closed T57012: 2.8 Modelling docs (Parent task), a subtask of T55018: Documentation for 2.8 (WIP), as Resolved.
Sun, Jul 14, 1:59 AM · BF Blender, Documentation
Aaron Carlisle (Blendify) closed T57012: 2.8 Modelling docs (Parent task) as Resolved.
Sun, Jul 14, 1:59 AM · Documentation
Aaron Carlisle (Blendify) closed T57008: Missing Metaball properties , a subtask of T57012: 2.8 Modelling docs (Parent task), as Resolved.
Sun, Jul 14, 1:58 AM · Documentation
Aaron Carlisle (Blendify) closed T57008: Missing Metaball properties as Resolved by committing rBM5506: Metaball: Radius.
Sun, Jul 14, 1:58 AM · Documentation
Aaron Carlisle (Blendify) closed T57439: 2.8 Tools (Parent Task), a subtask of T57012: 2.8 Modelling docs (Parent task), as Resolved.
Sun, Jul 14, 12:55 AM · Documentation
Aaron Carlisle (Blendify) closed T57439: 2.8 Tools (Parent Task) as Resolved.
Sun, Jul 14, 12:55 AM · Documentation
Aaron Carlisle (Blendify) closed T57463: Tools: New Scale cage tool, a subtask of T57439: 2.8 Tools (Parent Task), as Resolved.
Sun, Jul 14, 12:55 AM · Documentation
Aaron Carlisle (Blendify) closed T57463: Tools: New Scale cage tool as Resolved by committing rBM5503: Scale Cage tool.
Sun, Jul 14, 12:55 AM · Documentation

Sat, Jul 13

Aaron Carlisle (Blendify) closed T57471: Modelling: Multi-object editing, a subtask of T57012: 2.8 Modelling docs (Parent task), as Resolved.
Sat, Jul 13, 11:33 PM · Documentation
Aaron Carlisle (Blendify) closed T57471: Modelling: Multi-object editing as Resolved.
Sat, Jul 13, 11:33 PM · Documentation
Aaron Carlisle (Blendify) closed T57052: 2.8 UI (Parent Task), a subtask of T55018: Documentation for 2.8 (WIP), as Resolved.
Sat, Jul 13, 11:30 PM · BF Blender, Documentation
Aaron Carlisle (Blendify) closed T57052: 2.8 UI (Parent Task) as Resolved.
Sat, Jul 13, 11:30 PM · Documentation
Aaron Carlisle (Blendify) closed T57403: UI: Lattice: Add select more/less to menu, a subtask of T57052: 2.8 UI (Parent Task), as Resolved.
Sat, Jul 13, 11:29 PM · Documentation
Aaron Carlisle (Blendify) closed T57403: UI: Lattice: Add select more/less to menu as Resolved.
Sat, Jul 13, 11:29 PM · Documentation
Aaron Carlisle (Blendify) closed T57409: 2.8 Gizmos/manipulators (Parent task), a subtask of T57052: 2.8 UI (Parent Task), as Resolved.
Sat, Jul 13, 11:28 PM · Documentation
Aaron Carlisle (Blendify) closed T57409: 2.8 Gizmos/manipulators (Parent task) as Resolved.
Sat, Jul 13, 11:28 PM · Documentation
Aaron Carlisle (Blendify) closed T57418: 2.8 Viewport (Parent Task), a subtask of T55018: Documentation for 2.8 (WIP), as Resolved.
Sat, Jul 13, 10:35 PM · BF Blender, Documentation
Aaron Carlisle (Blendify) closed T57418: 2.8 Viewport (Parent Task) as Resolved.
Sat, Jul 13, 10:35 PM · Documentation