DocumentationProject
ActivePublic

Properties

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 and Section Owners:

The Administrators 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).
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

Fri, Aug 11

Bastien Montagne (mont29) triaged T52347: Weight Paint (Weight-Transfer) Does not work as documented as "Normal" priority.

Yep, doc would need an update, since one or two releases this tool now uses the more generic Mesh Data Transfer one, which by default only transfers active layer. Note that in the operator redo panel, you can select 'By Name' source layers, which will then transfer all existing ones in the source to the destination mesh.

Fri, Aug 11, 10:13 AM · Documentation
Brendon Murphy (meta-androcto) closed T52339: 2.79 Release Notes do not cover change to FBX exporter as "Resolved".

added some small note in release notes here:
https://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.79/Add-ons#FBX_I.2FO_.fbx
closing as resolved, i will ask @Bastien Montagne (mont29) if he's anything more to add.

Fri, Aug 11, 1:26 AM · Addons, Documentation, BF Blender

Thu, Aug 10

James Boddie (jrboddie) created T52339: 2.79 Release Notes do not cover change to FBX exporter.
Thu, Aug 10, 6:46 PM · Addons, Documentation, BF Blender

Sat, Aug 5

Aaron Carlisle (Blendify) created T52270: Add docs talking about the difference between disk and external caches.
Sat, Aug 5, 11:03 PM · Documentation
Aaron Carlisle (Blendify) closed T52269: Remove sphinx.util.compat.Directive from extensions as "Resolved" by committing rBM3724: Fix T52269: Remove sphinx.util.compat.Directive from extensions.
Sat, Aug 5, 10:46 PM · Documentation
Aaron Carlisle (Blendify) created T52269: Remove sphinx.util.compat.Directive from extensions.
Sat, Aug 5, 10:00 PM · Documentation

Thu, Aug 3

Aaron Carlisle (Blendify) added a comment to T50624: Split Glossary.

I have created a new structure, any thoughts @Tobias Heinke (TobiasH)?

Thu, Aug 3, 11:18 PM · Documentation
Aaron Carlisle (Blendify) closed T52256: mistake in documentation as "Resolved" by committing rBM3721: Fix T52256: Wrong wording for convert to docs.
Thu, Aug 3, 10:36 PM · Documentation
Aaron Carlisle (Blendify) claimed T52256: mistake in documentation.
Thu, Aug 3, 6:44 AM · Documentation
Andrey Sarafanov (ACap) edited the description of T52256: mistake in documentation.
Thu, Aug 3, 6:26 AM · Documentation
Andrey Sarafanov (ACap) created T52256: mistake in documentation.
Thu, Aug 3, 6:26 AM · Documentation

Sat, Jul 29

Robert Moore (robmoore) added a watcher for Documentation: Robert Moore (robmoore).
Sat, Jul 29, 10:14 PM
Aaron Carlisle (Blendify) added a member for Documentation: Robert Moore (robmoore).
Sat, Jul 29, 9:49 PM
Aaron Carlisle (Blendify) added a comment to rBMT1708: (RU)TRANSLATED -> (User interface/window_system/areas.po) + several adjustments….

@Viacheslav Atroschenko (atroschenko) you do not have to add the Documentation project to the commit, this just causes people to receive extra emails.

Sat, Jul 29, 9:06 PM
Joey Carr (joeycarr) removed a watcher for Documentation: Joey Carr (joeycarr).
Sat, Jul 29, 8:32 PM
Viacheslav Atroschenko (atroschenko) added a project to rBMT1708: (RU)TRANSLATED -> (User interface/window_system/areas.po) + several adjustments…: Documentation.
Sat, Jul 29, 8:29 PM

Fri, Jul 28

Aaron Carlisle (Blendify) added a member for Documentation: Jesus Balbastro (awesomehaircut).
Fri, Jul 28, 6:23 PM
Viacheslav Atroschenko (atroschenko) added a project to rBMT1703: Some RU translate to "User Interface" UM section: Documentation.
Fri, Jul 28, 2:26 PM · Documentation

Wed, Jul 26

Viacheslav Atroschenko (atroschenko) added a project to rBMT1696: Documentation.
Wed, Jul 26, 10:38 PM · Documentation
Aaron Carlisle (Blendify) added a member for Documentation: Viacheslav Atroschenko (atroschenko).
Wed, Jul 26, 3:22 PM
Viacheslav Atroschenko (atroschenko) added a watcher for Documentation: Viacheslav Atroschenko (atroschenko).
Wed, Jul 26, 12:45 PM

Jul 20 2017

Aaron Carlisle (Blendify) added a member for Documentation: Vuk Gardašević (lijenstina).
Jul 20 2017, 6:11 PM

Jul 15 2017

Aaron Carlisle (Blendify) closed T52074: Blender Manual: Wrong image for Surface Deform Modifier as "Resolved" by committing rBM3679: Fix T52074: Wrong image for Surface Deform Modifier.
Jul 15 2017, 10:55 PM · Documentation
Aaron Carlisle (Blendify) added a member for Documentation: Kulchynskiy Yuriy (urko).
Jul 15 2017, 9:50 PM
Vuk Gardašević (lijenstina) created T52074: Blender Manual: Wrong image for Surface Deform Modifier.
Jul 15 2017, 8:26 PM · Documentation

Jun 29 2017

Reiner Prokein (tiles) added a comment to T51908: Make Dupli-Face tool manual entry confusing.

Thanks :)

Jun 29 2017, 8:15 AM · Documentation

Jun 28 2017

Aaron Carlisle (Blendify) added a comment to T51908: Make Dupli-Face tool manual entry confusing.

Ok, it should go to the correct URL in the next available version.

Jun 28 2017, 11:11 PM · Documentation
Reiner Prokein (tiles) added a comment to T51908: Make Dupli-Face tool manual entry confusing.

Indeed. No 404 anymore. I forgot to check this in the newest version. But the link now leads to https://docs.blender.org/manual/en/dev/editors/3dview/object/index.html#bpy-ops-object . And the manual entry is at http://docs.blender.org/manual/ja/dev/editors/3dview/object/properties/duplication/duplifaces.html

Jun 28 2017, 9:10 AM · Documentation
Aaron Carlisle (Blendify) added a comment to T51908: Make Dupli-Face tool manual entry confusing.

The manual entry for Make Dupli-Face tool is confusing. The explanation does not involve to use the tool at all. The link from the Make Dupli-Face operator in the menu leads to 404. The purpose of the tool itself cannot be figured out.

Jun 28 2017, 12:33 AM · Documentation

Jun 27 2017

Bastien Montagne (mont29) changed Type from Bug to To Do on T51908: Make Dupli-Face tool manual entry confusing.
Jun 27 2017, 2:50 PM · Documentation
Bastien Montagne (mont29) triaged T51908: Make Dupli-Face tool manual entry confusing as "Normal" priority.
Jun 27 2017, 2:49 PM · Documentation

Jun 24 2017

Aaron Carlisle (Blendify) edited the description of T51172: Blender Documentation Roadmap.
Jun 24 2017, 5:18 AM · Documentation
Aaron Carlisle (Blendify) closed T49786: Purposal for the Context Sensitive Manual Access Tool as "Resolved".

I committed rBAe2b5a9e68c29a40adeb70d2a108c06064662d93f I decided not to integrate it directly into blender because of speed and complexity. I think this is fine though since we do not move files around that much anymore.

Jun 24 2017, 5:15 AM · Documentation, BF Blender

Jun 23 2017

Aaron Carlisle (Blendify) closed D2384: Script to automatically update rna_manual_reference.py by committing rBDT659547dd63be: Dev Tools: Add util to auto update rna --> manual links.
Jun 23 2017, 7:58 AM · Documentation, BF Blender

Jun 22 2017

Dalai Felinto (dfelinto) closed T51863: PYAPI: CompositorNodeSwitchView have the wrong api docs as "Resolved" by committing rBbe4b5551c7a4: Fix T51863: CompositorNodeSwitchView have the wrong rna API.
Jun 22 2017, 10:28 AM · Python, Documentation, Compositing, BF Blender

Jun 21 2017

Aaron Carlisle (Blendify) triaged T51863: PYAPI: CompositorNodeSwitchView have the wrong api docs as "Normal" priority.
Jun 21 2017, 9:49 PM · Python, Documentation, Compositing, BF Blender
Aaron Carlisle (Blendify) assigned T51863: PYAPI: CompositorNodeSwitchView have the wrong api docs to Dalai Felinto (dfelinto).
Jun 21 2017, 9:49 PM · Python, Documentation, Compositing, BF Blender
Aaron Carlisle (Blendify) created T51863: PYAPI: CompositorNodeSwitchView have the wrong api docs.
Jun 21 2017, 9:49 PM · Python, Documentation, Compositing, BF Blender

Jun 16 2017

Bastien Montagne (mont29) closed T51810: Create example for bpy.app.translations as "Resolved" by committing rBfc4154f857ba: Fix T51810: Add minimal example of usage of translation API for non-official….
Jun 16 2017, 4:44 PM · Documentation, Python
Bastien Montagne (mont29) added a comment to T51810: Create example for bpy.app.translations.

We do not need code example, looks like we need some stupid empty line to make sphinx happy…

Jun 16 2017, 4:31 PM · Documentation, Python
Aaron Carlisle (Blendify) moved T51810: Create example for bpy.app.translations from Backlog to Python API on the Documentation board.
Jun 16 2017, 5:18 AM · Documentation, Python
Aaron Carlisle (Blendify) moved T51387: Macro (bpy.types.Macro) needs proper documentation from Backlog to Python API on the Documentation board.
Jun 16 2017, 5:18 AM · Python, Documentation
Aaron Carlisle (Blendify) moved T51172: Blender Documentation Roadmap from Backlog to Administrative on the Documentation board.
Jun 16 2017, 5:17 AM · Documentation
Aaron Carlisle (Blendify) closed T51473: API: images, use external image with sphinx 1.6 as "Invalid".

We decided to host this doc on the manual instead.

Jun 16 2017, 5:17 AM · Python, Documentation
Aaron Carlisle (Blendify) closed D2621: API Docs: Add html logo by committing rBa348023196bf: PyAPI: Add HTML logo and favicon.
Jun 16 2017, 4:02 AM · Python, BF Blender, Documentation

Jun 14 2017

Aaron Carlisle (Blendify) triaged T51810: Create example for bpy.app.translations as "Normal" priority.
Jun 14 2017, 11:37 PM · Documentation, Python
Aaron Carlisle (Blendify) created T51810: Create example for bpy.app.translations.
Jun 14 2017, 11:36 PM · Documentation, Python
Campbell Barton (campbellbarton) added a comment to T51473: API: images, use external image with sphinx 1.6.

Tsk, my bad was thinking this was related to the manual. +1.

Jun 14 2017, 9:09 PM · Python, Documentation
Aaron Carlisle (Blendify) added a comment to T51473: API: images, use external image with sphinx 1.6.

Currently, the only images in use are on this page: https://docs.blender.org/api/current/info_tutorial_addon.html

Jun 14 2017, 9:07 PM · Python, Documentation
Campbell Barton (campbellbarton) added a comment to T51473: API: images, use external image with sphinx 1.6.
  • What are the benefits / whats this solve?
  • What are the down-sides?
  • What will the figure/image URL look like before/after?
  • How would this impact building PDF?
Jun 14 2017, 8:52 PM · Python, Documentation