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.
This project aims at replacing and updating the current Blender Manual.

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

Aaron Carlisle (Blendify) closed T57023: Remove Armature sketching as Resolved by committing rBM4479: 2.8 docs: remove armature sketching.
Fri, Nov 16, 4:44 AM · Documentation
Aaron Carlisle (Blendify) closed T57023: Remove Armature sketching, a subtask of T57009: 2.8 Rigging docs (Parent task), as Resolved.
Fri, Nov 16, 4:44 AM · Documentation
Aaron Carlisle (Blendify) accepted D3935: rBM 2.80 upgrade, section User Interface - Extended Controls - List View and Presets.
Fri, Nov 16, 4:13 AM · Documentation
Aaron Carlisle (Blendify) accepted D3928: rBM 2.80 upgrade, section User Interface - Extended Controls - Data Block Menu.
Fri, Nov 16, 4:12 AM · Documentation
Aaron Carlisle (Blendify) accepted D3925: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Numbers.
Fri, Nov 16, 4:10 AM · Documentation
Aaron Carlisle (Blendify) accepted D3921: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Toggles and Radio Buttons.
Fri, Nov 16, 4:07 AM · Documentation
Aaron Carlisle (Blendify) accepted D3920: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Menus.
Fri, Nov 16, 4:03 AM · Documentation
Aaron Carlisle (Blendify) requested changes to D3915: rBM 2.80 upgrade, section User Interface - Window System - Tabs and Panels.
Fri, Nov 16, 4:01 AM · Documentation
Aaron Carlisle (Blendify) accepted D3914: rBM 2.80 upgrade, section User Interface - Window System - Regions.
Fri, Nov 16, 3:58 AM · Documentation
Aaron Carlisle (Blendify) requested changes to D3909: rBM 2.80 upgrade, section User Interface - Window System - Areas.
Fri, Nov 16, 3:55 AM · Documentation
Aaron Carlisle (Blendify) accepted D3906: rBM 2.80 upgrade, section User Interface - Window System - Workspaces.
Fri, Nov 16, 3:47 AM · Documentation
Aaron Carlisle (Blendify) accepted D3904: rBM 2.80 upgrade, section User Interface - Splash.
Fri, Nov 16, 3:45 AM · Documentation
Aaron Carlisle (Blendify) closed T57006: Remove BGE docs, a subtask of T55018: Documentation for 2.8 (WIP), as Resolved.
Fri, Nov 16, 3:43 AM · Code Quest, BF Blender: 2.8, Documentation
Aaron Carlisle (Blendify) closed T57006: Remove BGE docs as Resolved by committing rBM4476: 2.8 Docs: Remove the Blender Game Engine.
Fri, Nov 16, 3:43 AM · Documentation

Tue, Nov 13

Aaron Carlisle (Blendify) merged T57798: Blender Manual download is broken into T57815: blender manual zip 2.79 EN.
Tue, Nov 13, 8:40 PM · Documentation
Aaron Carlisle (Blendify) assigned T57815: blender manual zip 2.79 EN to Brecht Van Lommel (brecht).

@Brecht Van Lommel (brecht) this must be from when you moved the files around. Maybe you forgot to move the zip files?

Tue, Nov 13, 6:41 PM · Documentation
Piotr Kudzin (sng84) created T57815: blender manual zip 2.79 EN.
Tue, Nov 13, 6:36 PM · Documentation
Brecht Van Lommel (brecht) added a comment to T48096: New Wiki.

@Benjamin Humpherys (brhumphe), the versioning in the old wiki was never actually used for developer docs. The individual history of pages can be used to go back to a specific date, however build instructions are actually identical for master (2.7) and blender2.8 branches.

Tue, Nov 13, 11:34 AM · Documentation, Infrastructure: Websites
Aaron Carlisle (Blendify) abandoned D3149: Manual: Remove main bge python api docs.
Tue, Nov 13, 4:09 AM · Python, Game Engine, BF Blender, Documentation

Mon, Nov 12

Inês Almeida (brita_) updated subscribers of T48096: New Wiki.

@Benjamin Humpherys (brhumphe) The Blender User Manual does have versioning: https://docs.blender.org/manual/ . But you say compile? That shouldn't really change, it would be nice to have an easier explanation of how to work with branches, but otherwise, I don't think it needs versioning.

Mon, Nov 12, 9:48 PM · Documentation, Infrastructure: Websites
Benjamin Humpherys (brhumphe) added a comment to T48096: New Wiki.

One request regarding the new wiki I would like to see: explicit version numbers. The new wiki does not specify which version of Blender the articles are relevant to. Something I appreciate that the Python documentation does and the old wiki does is have a selectable version dropdown menu which allows you to make sure the version of the page you are reading is correct for the version you are working with, and select a different version and be immediately taken to the correct page. I've been hitting a lot of dead links lately trying to figure out which set of build instructions is correct for 2.7, which has been a bit difficult since the old wiki does not have anything labeled 2.7, but the instructions in the new wiki are specific to the latest builds of 2.8.

Mon, Nov 12, 8:05 PM · Documentation, Infrastructure: Websites
Aaron Carlisle (Blendify) updated the task description for T57419: Viewport: Overlays.
Mon, Nov 12, 7:34 PM · Documentation
Brecht Van Lommel (brecht) added a comment to T48096: New Wiki.

This all seems reasonable.

Mon, Nov 12, 7:10 PM · Documentation, Infrastructure: Websites
Sergey Sharybin (sergey) added a comment to T48096: New Wiki.

Here are some instructions which might help with static-isfying the old wiki: http://camwebb.info/blog/2012-12-20/

Mon, Nov 12, 6:53 PM · Documentation, Infrastructure: Websites
Tuomo Keskitalo (tkeskita) added a comment to T54097: Proposal: Addon documentation for 2.8.

What's the latest news on the fate of add-ons in Blender 2.80?

Mon, Nov 12, 5:47 PM · Documentation, Addons
Tuomo Keskitalo (tkeskita) added a comment to T57052: 2.8 UI (Parent Task).

Patch for review for 2.80 Manual upgrade, section User Interface - Extended Controls - List View and Presets: D3935

Mon, Nov 12, 5:33 PM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to D3935: rBM 2.80 upgrade, section User Interface - Extended Controls - List View and Presets.

Attached images associated to patch.

Mon, Nov 12, 5:32 PM · Documentation
Tuomo Keskitalo (tkeskita) created D3935: rBM 2.80 upgrade, section User Interface - Extended Controls - List View and Presets.
Mon, Nov 12, 5:31 PM · Documentation

Sun, Nov 11

Inês Almeida (brita_) added a comment to T48096: New Wiki.

Plan for completing the wiki migration:

Sun, Nov 11, 10:28 PM · Documentation, Infrastructure: Websites
Aaron Carlisle (Blendify) reopened T42765: Italian translation (Blender UI and manual) as "Open".

I will leave open for a bit longer.

Sun, Nov 11, 9:07 PM · Documentation, Translations

Sat, Nov 10

Tuomo Keskitalo (tkeskita) added a comment to T57052: 2.8 UI (Parent Task).

Patch for review for 2.80 Manual upgrade, section User Interface - Extended Controls - Data Block Menu: D3928

Sat, Nov 10, 11:47 AM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to D3928: rBM 2.80 upgrade, section User Interface - Extended Controls - Data Block Menu.

This chapter was a bit hard. I'm unsure if "Sub IDs" is a real thing in Blender? If it's not, then that part should be removed.

Sat, Nov 10, 11:45 AM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to D3928: rBM 2.80 upgrade, section User Interface - Extended Controls - Data Block Menu.

Attached images associated to patch.

Sat, Nov 10, 11:41 AM · Documentation
Tuomo Keskitalo (tkeskita) created D3928: rBM 2.80 upgrade, section User Interface - Extended Controls - Data Block Menu.
Sat, Nov 10, 11:40 AM · Documentation

Fri, Nov 9

Tuomo Keskitalo (tkeskita) added a comment to T57052: 2.8 UI (Parent Task).

Patch for review for 2.80 Manual upgrade, section User Interface - Window System - Buttons - Numbers: D3925

Fri, Nov 9, 5:24 PM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to D3925: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Numbers.

Attached images associated to patch.

Fri, Nov 9, 5:23 PM · Documentation
Tuomo Keskitalo (tkeskita) created D3925: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Numbers.
Fri, Nov 9, 5:22 PM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to T57052: 2.8 UI (Parent Task).

Patch for review for 2.80 Manual upgrade, section User Interface - Window System - Buttons - Toggles and Radio Buttons: D3921

Fri, Nov 9, 11:27 AM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to D3921: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Toggles and Radio Buttons.

Attached images associated to patch.

Fri, Nov 9, 11:25 AM · Documentation
Tuomo Keskitalo (tkeskita) created D3921: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Toggles and Radio Buttons.
Fri, Nov 9, 11:24 AM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to T57052: 2.8 UI (Parent Task).

Patch for review for 2.80 Manual upgrade, section User Interface - Window System - Buttons - Menus: D3920

Fri, Nov 9, 9:20 AM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to D3920: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Menus.

Attached images associated with patch.

Fri, Nov 9, 9:18 AM · Documentation
Tuomo Keskitalo (tkeskita) created D3920: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Menus.
Fri, Nov 9, 9:17 AM · Documentation

Thu, Nov 8

Aaron Carlisle (Blendify) moved T57706: Animation: Option to do keyframe insertion in a cycle-aware fashion from Backlog to Blender 2.8 on the Documentation board.
Thu, Nov 8, 8:41 PM · Documentation
derek barker (lordodin) added a comment to T57700: Cycles: Added Embree as BVH option for CPU renders.

Oh my bad. Well then this is definitely excellent news

Thu, Nov 8, 6:44 PM · Documentation
Brecht Van Lommel (brecht) added a comment to T57700: Cycles: Added Embree as BVH option for CPU renders.

No, that's not the case, when we switch to Embree we would ensure our GPU rendering matches it.

Thu, Nov 8, 6:35 PM · Documentation
derek barker (lordodin) added a comment to T57700: Cycles: Added Embree as BVH option for CPU renders.

So GPU and CPU rendering wont work anymore.. that sounds great

Thu, Nov 8, 6:29 PM · Documentation
Brecht Van Lommel (brecht) closed T57399: Cycles: Noise image pass (denoising) as Resolved by committing rBM4470: Cycles: add docs for cryptomatte, denoising data, and fix some errors..
Thu, Nov 8, 6:09 PM · Documentation
Brecht Van Lommel (brecht) closed T57399: Cycles: Noise image pass (denoising), a subtask of T57027: 2.8 Cycles (Parent Task), as Resolved.
Thu, Nov 8, 6:09 PM · Documentation
Brecht Van Lommel (brecht) closed T57399: Cycles: Noise image pass (denoising), a subtask of T57398: 2.8 Render Layers and Passes (Parent Task), as Resolved.
Thu, Nov 8, 6:09 PM · Documentation