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

Evan Wilson (EAW) added a comment to T74242: Drivers don't update properly.

I took a look at this yesterday, and was trying to find the right report to merge this into (looks like T64793 is the chosen one), and another report to link that gave the explanation (found it: T72899). Glad @paul szajner (szap) appeared with the explanation and the updated blend!

Fri, Feb 28, 2:31 AM · Documentation

Yesterday

Johan Walles (walles) added a comment to T74242: Drivers don't update properly.

Thanks for the clarification @paul szajner (szap)!

Thu, Feb 27, 9:41 PM · Documentation
paul szajner (szap) updated subscribers of T74242: Drivers don't update properly.

The main difference between the example and your case is that in the example it take a property of object A to drive object B.
In your case it's a property from object A that drives object A.

Thu, Feb 27, 8:48 PM · Documentation
Aaron Carlisle (Blendify) reopened T74242: Drivers don't update properly as "Needs Triage".

I will look into the documentation tomorrow if I get a chance.

Thu, Feb 27, 8:29 PM · Documentation
Richard Antalik (ISS) placed T73756: Animating influence of 'Child Of' bone constraint causing motion blur errors. up for grabs.
Thu, Feb 27, 2:48 PM · Documentation, Cycles, BF Blender

Wed, Feb 26

Aaron Carlisle (Blendify) updated the task description for T73347: 2.83 Documentation.
Wed, Feb 26, 11:49 PM · BF Blender (2.83), Development Management, Documentation
Eitan (EitanSomething) added a comment to D6612: Manual:Rename cut operator to split.

This can now be committed

Wed, Feb 26, 10:41 PM · Video Sequencer, Documentation
Aaron Carlisle (Blendify) accepted D6612: Manual:Rename cut operator to split.

This can now be committed

Wed, Feb 26, 10:31 PM · Video Sequencer, Documentation
Aaron Carlisle (Blendify) changed the status of T74218: Problems when running 'make update_po' in BASH shell on MacOS from Needs Triage to Needs Information from User.

find is a standard bash command.

Wed, Feb 26, 10:26 PM · Documentation
Aaron Carlisle (Blendify) added a comment to T74218: Problems when running 'make update_po' in BASH shell on MacOS.

find is a standard bash command.

Wed, Feb 26, 10:20 PM · Documentation
Aaron Carlisle (Blendify) closed T70624: 2.81 Missing Features in Manual as Resolved.
Wed, Feb 26, 9:41 PM · BF Blender (2.83), Documentation, Development Management
Aaron Carlisle (Blendify) updated the task description for T74218: Problems when running 'make update_po' in BASH shell on MacOS.
Wed, Feb 26, 5:50 PM · Documentation
Hoang Duy Tran (hoangduytran) updated the task description for T74218: Problems when running 'make update_po' in BASH shell on MacOS.
Wed, Feb 26, 5:49 PM · Documentation
Aaron Carlisle (Blendify) moved T73756: Animating influence of 'Child Of' bone constraint causing motion blur errors. from Backlog to Improve documentation on the Documentation board.
Wed, Feb 26, 5:45 PM · Documentation, Cycles, BF Blender
Aaron Carlisle (Blendify) removed a project from T74218: Problems when running 'make update_po' in BASH shell on MacOS: BF Blender.
Wed, Feb 26, 4:39 PM · Documentation
Ankit (ankitm) added a comment to T74218: Problems when running 'make update_po' in BASH shell on MacOS.

Hi! please use code formatting to separate your comments and commands/output. use three backticks ` to start a code block, three to end it.

Wed, Feb 26, 3:34 PM · Documentation
Campbell Barton (campbellbarton) added a comment to T73756: Animating influence of 'Child Of' bone constraint causing motion blur errors..

Marking as documentation TODO.

Wed, Feb 26, 3:53 AM · Documentation, Cycles, BF Blender
Campbell Barton (campbellbarton) changed the subtype of T73756: Animating influence of 'Child Of' bone constraint causing motion blur errors. from "Report" to "To Do".
Wed, Feb 26, 3:53 AM · Documentation, Cycles, BF Blender
Campbell Barton (campbellbarton) changed the status of T73756: Animating influence of 'Child Of' bone constraint causing motion blur errors. from Needs Information from User to Confirmed.
Wed, Feb 26, 3:53 AM · Documentation, Cycles, BF Blender
Hoang Duy Tran (hoangduytran) updated the task description for T74218: Problems when running 'make update_po' in BASH shell on MacOS.
Wed, Feb 26, 3:11 AM · Documentation
Hoang Duy Tran (hoangduytran) added a project to T74218: Problems when running 'make update_po' in BASH shell on MacOS: Documentation.
Wed, Feb 26, 2:38 AM · Documentation

Tue, Feb 25

Eitan (EitanSomething) updated the diff for D6612: Manual:Rename cut operator to split.
  • Rename cut operator to split
Tue, Feb 25, 2:15 AM · Video Sequencer, Documentation
Aaron Carlisle (Blendify) closed T66728: Dopesheet filters as Resolved by committing rBM6282: DopeSheet: Filters.
Tue, Feb 25, 1:08 AM · Documentation

Mon, Feb 24

Aaron Carlisle (Blendify) updated the task description for T70624: 2.81 Missing Features in Manual.
Mon, Feb 24, 11:39 PM · BF Blender (2.83), Documentation, Development Management
Aaron Carlisle (Blendify) updated the task description for T70624: 2.81 Missing Features in Manual.
Mon, Feb 24, 9:53 PM · BF Blender (2.83), Documentation, Development Management
Aaron Carlisle (Blendify) updated the task description for T70624: 2.81 Missing Features in Manual.
Mon, Feb 24, 9:35 PM · BF Blender (2.83), Documentation, Development Management
Aaron Carlisle (Blendify) updated the task description for T70624: 2.81 Missing Features in Manual.
Mon, Feb 24, 8:20 PM · BF Blender (2.83), Documentation, Development Management
Aaron Carlisle (Blendify) updated the task description for T70624: 2.81 Missing Features in Manual.
Mon, Feb 24, 7:38 PM · BF Blender (2.83), Documentation, Development Management
Aaron Carlisle (Blendify) updated the task description for T70624: 2.81 Missing Features in Manual.
Mon, Feb 24, 6:53 PM · BF Blender (2.83), Documentation, Development Management
Aaron Carlisle (Blendify) updated the task description for T70624: 2.81 Missing Features in Manual.
Mon, Feb 24, 6:38 PM · BF Blender (2.83), Documentation, Development Management

Thu, Feb 20

Tobias Heinke (TobiasH) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

never mind, I overlooked that you have edited the script.

Thu, Feb 20, 11:13 PM · BF Blender (2.83), Add-ons, Documentation
Aaron Carlisle (Blendify) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

@Tobias Heinke (TobiasH) can you better explain that, you have a double negative and I am not exactly sure what part of this task you are responding to.

Thu, Feb 20, 8:26 PM · BF Blender (2.83), Add-ons, Documentation
Tobias Heinke (TobiasH) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.
Thu, Feb 20, 7:54 PM · BF Blender (2.83), Add-ons, Documentation
Sebastián Barschkis (sebbas) closed T74013: Update Remaining Fluid Documentation as Resolved.

@Aaron Carlisle (Blendify) I would say that with rBM6263 we have a good first version of the new fluid manual.

Thu, Feb 20, 2:11 PM · Documentation
Brecht Van Lommel (brecht) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

That's all fine with me, the precise naming and syntax I'll leave up to Python and Add-on project maintainers. If we want to rename wiki_url, it can be done in a way that's backwards compatible.

Thu, Feb 20, 2:02 PM · BF Blender (2.83), Add-ons, Documentation
Sybren A. Stüvel (sybren) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

The idea with my patch would be to have either a manual_reference or a wiki_url for an add-on info, never both.
[…]
Instead of adding another field, we could keeping using wiki_url

Thu, Feb 20, 1:55 PM · BF Blender (2.83), Add-ons, Documentation
Brecht Van Lommel (brecht) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

The idea with my patch would be to have either a manual_reference or a wiki_url for an add-on info, never both. When the add-on is loaded, the URL will then be expanded to include the version.

Thu, Feb 20, 1:08 PM · BF Blender (2.83), Add-ons, Documentation
Brendon Murphy (meta-androcto) updated subscribers of T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

hi, I think this is not a good solution unless it's temporary. Leading up to 2.82 bcon2, I made sure all addons linked to their correct manual pages. Every included addon should have a permanent page on the Manual.
If this only affects i/o addons then we can simply change the bl_info wiki_url to point to the correct manual page leading up to 2.83.
Adding a duplicate field to all addons: wiki_url and the proposed manual_url are the same thing, an internally used name to point addons to their documentation. @Campbell Barton (campbellbarton) what is your opinion here?
@Aaron Carlisle (Blendify)
If this change has broken all 2.82 i/o manual links, it will need to be redirected by the manual until 2.83.
I'm happy to help fix the i/o addons current links in 2.83 master, linking them to the new manual page.

Thu, Feb 20, 8:31 AM · BF Blender (2.83), Add-ons, Documentation
Aaron Carlisle (Blendify) lowered the priority of T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons from High to Normal.
Thu, Feb 20, 5:14 AM · BF Blender (2.83), Add-ons, Documentation
Aaron Carlisle (Blendify) moved T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons from Backlog to Documentation on the BF Blender (2.83) board.
Thu, Feb 20, 5:10 AM · BF Blender (2.83), Add-ons, Documentation
Aaron Carlisle (Blendify) changed the subtype of T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons from "Report" to "To Do".

Leaving as a todo to address the URL for 2.83

Thu, Feb 20, 5:09 AM · BF Blender (2.83), Add-ons, Documentation
Aaron Carlisle (Blendify) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

I have added a redirect so the initial report is fixed. In the future, now that we know can do this, hopefully, create an automated (maybe semi-manual) method to write redirects.

Thu, Feb 20, 5:08 AM · BF Blender (2.83), Add-ons, Documentation
Brecht Van Lommel (brecht) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

@Aaron Carlisle (Blendify), maybe something like this (untested):

diff --git a/release/scripts/modules/addon_utils.py b/release/scripts/modules/addon_utils.py
index b58c683dc24..aebb465a037 100644
--- a/release/scripts/modules/addon_utils.py
+++ b/release/scripts/modules/addon_utils.py
@@ -506,6 +506,7 @@ def module_bl_info(mod, info_basis=None):
             "location": "",
             "description": "",
             "wiki_url": "",
+            "manual_reference": "",
             "support": 'COMMUNITY',
             "category": "",
             "warning": "",
@@ -527,5 +528,12 @@ def module_bl_info(mod, info_basis=None):
     if not addon_info["name"]:
         addon_info["name"] = mod.__name__
Thu, Feb 20, 1:42 AM · BF Blender (2.83), Add-ons, Documentation
Aaron Carlisle (Blendify) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

To clarify on Trouble's comment, I meant to automatically adjust the version number from the addon side instead of the server-side.

Thu, Feb 20, 12:34 AM · BF Blender (2.83), Add-ons, Documentation
Dan McGrath (dmcgrath) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

And we should definitely fix the add-ons docs links somehow including dev, it should contain the release number for official releases.

is there a way to add

def manual_version(self, _context):
    if bpy.app.version_cycle in {"rc", "release"}:
        manual_version = "%d.%d" % bpy.app.version[:2]
    else:
        manual_version = "dev"
    return manual_version

to addon_utils.py? so we can

'wiki_url': "https://docs.blender.org/manual/en/' + manual_version + '/addons/import_export/io_scene_gltf2.html",

If not we can manually bump the version with the release but I would rather automate this.

For the moment I am working on a redirect that we can enable for the release

Thu, Feb 20, 12:21 AM · BF Blender (2.83), Add-ons, Documentation

Wed, Feb 19

Aaron Carlisle (Blendify) claimed T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

And we should definitely fix the add-ons docs links somehow including dev, it should contain the release number for official releases.

Wed, Feb 19, 11:51 PM · BF Blender (2.83), Add-ons, Documentation
Dan McGrath (dmcgrath) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

I took a look, and it appears that mod_rewrite stuff should be part of the FileInfo override that we already have in place. So you should be able to patch stuff up in the commits as well.

Wed, Feb 19, 11:07 PM · BF Blender (2.83), Add-ons, Documentation
Brecht Van Lommel (brecht) changed the status of T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons from Needs Triage to Confirmed.

And we should definitely fix the add-ons docs links somehow including dev, it should contain the release number for official releases.

Wed, Feb 19, 10:58 PM · BF Blender (2.83), Add-ons, Documentation
Aaron Carlisle (Blendify) updated the task description for T70624: 2.81 Missing Features in Manual.
Wed, Feb 19, 10:58 PM · BF Blender (2.83), Documentation, Development Management
Brecht Van Lommel (brecht) added a comment to T74017: Documentation links broken in 2.82 after recent documentation url changes for IO addons.

@Aaron Carlisle (Blendify), I don't agree, this seems like a serious issue.

Wed, Feb 19, 10:57 PM · BF Blender (2.83), Add-ons, Documentation