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

Thu, Jul 20

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

Sat, Jul 15

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.
Sat, Jul 15, 10:55 PM · Documentation
Aaron Carlisle (Blendify) added a member for Documentation: Kulchynskiy Yuriy (urko).
Sat, Jul 15, 9:50 PM
Vuk Gardašević (lijenstina) created T52074: Blender Manual: Wrong image for Surface Deform Modifier.
Sat, Jul 15, 8:26 PM · Documentation

Thu, Jun 29

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

Thanks :)

Thu, Jun 29, 8:15 AM · Documentation

Wed, Jun 28

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.

Wed, Jun 28, 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

Wed, Jun 28, 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.

Wed, Jun 28, 12:33 AM · Documentation

Tue, Jun 27

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

Sat, Jun 24

Aaron Carlisle (Blendify) edited the description of T51172: Blender Documentation Roadmap.
Sat, Jun 24, 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.

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

Fri, Jun 23

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.
Fri, Jun 23, 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
Aaron Carlisle (Blendify) added inline comments to D2711: PYAPI: Add more information to bge video texture docs.
Jun 14 2017, 7:02 PM · Game Engine, Python, Documentation, BF Blender
Porteries Tristan (panzergame) added inline comments to D2711: PYAPI: Add more information to bge video texture docs.
Jun 14 2017, 6:30 PM · Game Engine, Python, Documentation, BF Blender
Porteries Tristan (panzergame) added a reviewer for D2711: PYAPI: Add more information to bge video texture docs: Benoit Bolsee (ben2610).
Jun 14 2017, 6:20 PM · Game Engine, Python, Documentation, BF Blender
Aaron Carlisle (Blendify) created D2711: PYAPI: Add more information to bge video texture docs.
Jun 14 2017, 5:44 PM · Game Engine, Python, Documentation, BF Blender

Jun 11 2017

Aaron Carlisle (Blendify) added projects to T51771: "Normal" with two meanings: Translations, Documentation.
Jun 11 2017, 7:35 PM · Documentation, Translations

Jun 6 2017

Aaron Carlisle (Blendify) added a comment to D2384: Script to automatically update rna_manual_reference.py.

Yes, that works thanks for the tip.

Jun 6 2017, 6:19 PM · Documentation, BF Blender
Bastien Montagne (mont29) added a comment to D2384: Script to automatically update rna_manual_reference.py.

OK, but in that case you cannot use for line in obj_temp:, since you need to sort all lines. Something like that should work?

Jun 6 2017, 5:47 PM · Documentation, BF Blender
Aaron Carlisle (Blendify) added a comment to D2384: Script to automatically update rna_manual_reference.py.

The scripts downloads and decrypts the objects.inv file which looks like:

Jun 6 2017, 4:57 PM · Documentation, BF Blender
Bastien Montagne (mont29) added inline comments to D2384: Script to automatically update rna_manual_reference.py.
Jun 6 2017, 2:53 PM · Documentation, BF Blender

Jun 3 2017

Aaron Carlisle (Blendify) added a comment to D2384: Script to automatically update rna_manual_reference.py.

This is mostly functional but I am stuck on figuring out how to sort the lines depending on the length of split[0]
It would be nice to have this used for 2.79 so if anyone has any ideas that would be appreciated.

Jun 3 2017, 2:14 AM · Documentation, BF Blender
Aaron Carlisle (Blendify) updated the diff for D2384: Script to automatically update rna_manual_reference.py.

Update to master

Jun 3 2017, 1:58 AM · Documentation, BF Blender
Aaron Carlisle (Blendify) updated the diff for D2384: Script to automatically update rna_manual_reference.py.

Update script to work with new website

Jun 3 2017, 1:27 AM · Documentation, BF Blender

Jun 2 2017

Aaron Carlisle (Blendify) closed D2699: info_overview.rst doc cleanup by committing rB420d4a70b8fe: PyAPI: Cleanup "Python API Overview" doc (authored by nBurn (nBurn)).
Jun 2 2017, 11:30 PM · Documentation, BF Blender
nBurn (nBurn) updated the diff for D2699: info_overview.rst doc cleanup.

Updated diff patch with Blendify's recommendations.

Jun 2 2017, 8:54 PM · Documentation, BF Blender
Aaron Carlisle (Blendify) added inline comments to D2699: info_overview.rst doc cleanup.
Jun 2 2017, 4:41 AM · Documentation, BF Blender
nBurn (nBurn) added a comment to D2699: info_overview.rst doc cleanup.

I mostly agree with all your suggestions, I left a comment for the others.

Jun 2 2017, 4:33 AM · Documentation, BF Blender
Aaron Carlisle (Blendify) closed D2700: Minor doc update to bpy.types.Operator.5.py with expanded info on modal operation.

Committed in rBe1910ac6eda621f4f3670995779fa8a506331cf9

Jun 2 2017, 4:08 AM · Documentation, BF Blender
Aaron Carlisle (Blendify) accepted D2700: Minor doc update to bpy.types.Operator.5.py with expanded info on modal operation.
Jun 2 2017, 3:47 AM · Documentation, BF Blender
Aaron Carlisle (Blendify) accepted D2699: info_overview.rst doc cleanup.

Looks good only a few small nick picky things.

Jun 2 2017, 3:46 AM · Documentation, BF Blender
nBurn (nBurn) created D2700: Minor doc update to bpy.types.Operator.5.py with expanded info on modal operation.
Jun 2 2017, 3:44 AM · Documentation, BF Blender
nBurn (nBurn) created D2699: info_overview.rst doc cleanup.
Jun 2 2017, 1:41 AM · Documentation, BF Blender