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

Yesterday

Bastien Montagne (mont29) raised the priority of T61902: Documentation for building Blender with Xcode doesn't work from Needs Information from User to Normal.
Tue, Mar 19, 10:34 AM · Documentation

Mon, Mar 18

Brecht Van Lommel (brecht) added a comment to T62604: Blender 2.80.48 Video Editing Adding Scenes that are selected in the outliner bug/behavior?.

Yes, there's some instructions here:
https://docs.blender.org/manual/en/dev/about/contribute/index.html

Mon, Mar 18, 4:21 PM · Documentation, BF Blender, Video Sequencer
Richard Antalik (ISS) added a comment to T62604: Blender 2.80.48 Video Editing Adding Scenes that are selected in the outliner bug/behavior?.

@Richard Antalik (ISS), you actually have commit rights to the documentation repository (username and password and are the same as for logging into this site).

Mon, Mar 18, 3:58 PM · Documentation, BF Blender, Video Sequencer
Brecht Van Lommel (brecht) added a comment to T62604: Blender 2.80.48 Video Editing Adding Scenes that are selected in the outliner bug/behavior?.

@Richard Antalik (ISS), you actually have commit rights to the documentation repository (username and password and are the same as for logging into this site).

Mon, Mar 18, 3:45 PM · Documentation, BF Blender, Video Sequencer
Jacques Lucke (JacquesLucke) added a comment to T62674: In the documentation, the armature tab is not obvious.

There are a few other cases when Armature tab is used in the docs.
Should they all be replaced with Object Data or should Blender be changed?

Mon, Mar 18, 12:48 PM · Documentation
Jacques Lucke (JacquesLucke) triaged T62674: In the documentation, the armature tab is not obvious as Confirmed, Medium priority.
Mon, Mar 18, 12:47 PM · Documentation
Jacques Lucke (JacquesLucke) triaged T62675: Missing end of sentence in bone animation documentation. as Confirmed, Medium priority.

Not sure what belongs there...

Mon, Mar 18, 12:44 PM · Documentation
Bastien Montagne (mont29) placed T62696: Comment with no line number problem up for grabs.

This is the manual, not blender's i18n…

Mon, Mar 18, 12:30 AM · Documentation

Sun, Mar 17

Fabien Freling (ffreling) updated the task description for T62674: In the documentation, the armature tab is not obvious.
Sun, Mar 17, 11:21 AM · Documentation
Fabien Freling (ffreling) updated the task description for T62675: Missing end of sentence in bone animation documentation..
Sun, Mar 17, 11:21 AM · Documentation
Fabien Freling (ffreling) created T62675: Missing end of sentence in bone animation documentation..
Sun, Mar 17, 10:38 AM · Documentation
Fabien Freling (ffreling) created T62674: In the documentation, the armature tab is not obvious.
Sun, Mar 17, 10:36 AM · Documentation

Sat, Mar 16

Richard Antalik (ISS) added a project to T62604: Blender 2.80.48 Video Editing Adding Scenes that are selected in the outliner bug/behavior?: Documentation.

Task is more or less invalid, but docs should be fixed so I guess..
I can not make those changes (I think)

Sat, Mar 16, 1:00 AM · Documentation, BF Blender, Video Sequencer

Tue, Mar 12

Brecht Van Lommel (brecht) added a member for Documentation: Pablo Dobarro (pablodp606).
Tue, Mar 12, 7:09 PM
Brecht Van Lommel (brecht) closed T62374: Seconds instead of minutes as Resolved by committing rBM4591: Fix T62374: limits are in hours and minutes, not seconds..
Tue, Mar 12, 7:04 PM · Documentation

Mon, Mar 11

Tobias Heinke (TobiasH) closed T54879: Searching from 404 page leads to 404 page as Resolved.
Mon, Mar 11, 4:32 PM · Documentation
Tobias Heinke (TobiasH) added a comment to T51080: Blender Manual 404 page redesign .

I stumbled upon the magic solution: the <base> tag it defines the base url for relative links,
which makes the extension obsolete,
all links work now,
version is still dev, the baseURL is read-only so it can't be changed by the inline script.

Mon, Mar 11, 4:29 PM · Documentation

Sat, Mar 9

Sebastian Parborg (zeddb) assigned T62374: Seconds instead of minutes to Brecht Van Lommel (brecht).

Confirmed, should be 12 hours, 8.4 minutes.

Sat, Mar 9, 1:05 PM · Documentation
Russell (russ1642) created T62374: Seconds instead of minutes.
Sat, Mar 9, 12:04 AM · Documentation

Sat, Mar 2

Julien DUROURE (julien) closed D4422: Add glTF to import/export page.

Committed

Sat, Mar 2, 10:22 AM · Documentation
Julien DUROURE (julien) accepted D4422: Add glTF to import/export page.
Sat, Mar 2, 10:21 AM · Documentation

Fri, Mar 1

Ed Mackey (emackey) added a comment to D4422: Add glTF to import/export page.

@Julien DUROURE (julien) Can we add this? Thanks!

Fri, Mar 1, 5:35 PM · Documentation

Thu, Feb 28

Finn Bear (finnb) added a comment to T61875: Compositing node Vector -> Normalize inputs and outputs scalars not vectors.

Also, where can I find "design tasks?"

Thu, Feb 28, 7:39 AM · Documentation, BF Blender
Finn Bear (finnb) added a comment to T61875: Compositing node Vector -> Normalize inputs and outputs scalars not vectors.

The vector category wouldn't be almost empty if a try "normalize" node was added. The current "normalize" node could be renamed "normalize channel."

Thu, Feb 28, 7:38 AM · Documentation, BF Blender
Ed Mackey (emackey) created D4422: Add glTF to import/export page.
Thu, Feb 28, 1:14 AM · Documentation

Wed, Feb 27

Chris Evans (mgchris) added a comment to T61902: Documentation for building Blender with Xcode doesn't work.

@Arto Kitula (akitula) I used CMake GUI (3.14.0-rc2).
Steps:

  1. Get latest code from master (From commit b9a37dd97acf6c4254e8246add7af05d68c8bf64).
  2. Deleted my output folder (Where to build the binaries)
  3. In CMake GUI clicked Configure and waited for it to finish
  4. In CMake GUI clicked Generate and waited for it to finish
  5. Open Xcode selected the install Scheme (Note it might be better to say Press Command+shift+, instead of Command-<)
  6. Have Xcode Automatically Create Schemes. (Maybe update the docs saying to select that option?)
  7. Changed Executable to blender.app
  8. Build and get 30 build errors relating to Undefined symbols for architecture x86_64: for a bunch of boost methods.
Wed, Feb 27, 9:24 PM · Documentation

Tue, Feb 26

Arto Kitula (akitula) lowered the priority of T61902: Documentation for building Blender with Xcode doesn't work from Normal to Needs Information from User.

It should not be necessary to manually set WITH_BOOST in any case, that would indicate a bug in the build system that needs to be fixed.

Tue, Feb 26, 8:57 PM · Documentation
Brecht Van Lommel (brecht) added a comment to T61902: Documentation for building Blender with Xcode doesn't work.

It should not be necessary to manually set WITH_BOOST in any case, that would indicate a bug in the build system that needs to be fixed.

Tue, Feb 26, 8:26 PM · Documentation
Arto Kitula (akitula) added a comment to T61902: Documentation for building Blender with Xcode doesn't work.

What exactly you'd like to edit? Did you first run make update under source tree before cmake/cmake gui?

Tue, Feb 26, 8:17 PM · Documentation
Jacques Lucke (JacquesLucke) added a comment to T61875: Compositing node Vector -> Normalize inputs and outputs scalars not vectors.

Hmmm, I'm not sure... Maybe this should be discussed in a design task.

Tue, Feb 26, 1:50 PM · Documentation, BF Blender
William Reynish (billreynish) added a comment to T61875: Compositing node Vector -> Normalize inputs and outputs scalars not vectors.

As @Finn Bear (finnb) points out, that could be argued for almost all the nodes in the Vector category.

Tue, Feb 26, 1:43 PM · Documentation, BF Blender
Jacques Lucke (JacquesLucke) updated subscribers of T61875: Compositing node Vector -> Normalize inputs and outputs scalars not vectors.

@Finn Bear (finnb), you are right. That does not really make sense.

Tue, Feb 26, 1:38 PM · Documentation, BF Blender
Joshua Newth (shamayimjosh) triaged T61966: Broken link concerning an excellent recommended external python scripting resource in the Blender 2.79 Manual as Normal priority.
Tue, Feb 26, 5:42 AM · Documentation
Finn Bear (finnb) added a comment to T61875: Compositing node Vector -> Normalize inputs and outputs scalars not vectors.

@Jacques Lucke (JacquesLucke) Now I'm wondering why this node is in the "Vector" category, and that actually applies to most of the nodes there. This nodes, except vector curves, really stretch the meaning of "vector."

Tue, Feb 26, 3:56 AM · Documentation, BF Blender

Mon, Feb 25

Sebastian Parborg (zeddb) assigned T61902: Documentation for building Blender with Xcode doesn't work to Arto Kitula (akitula).
Mon, Feb 25, 5:30 PM · Documentation
Jacques Lucke (JacquesLucke) closed T61875: Compositing node Vector -> Normalize inputs and outputs scalars not vectors as Resolved by committing rBM4574: Fix T61875: wrong normalize node description.
Mon, Feb 25, 3:22 PM · Documentation, BF Blender
Jacques Lucke (JacquesLucke) claimed T61875: Compositing node Vector -> Normalize inputs and outputs scalars not vectors.

The actual problem here seems to be the documentation, not the implementation.

Mon, Feb 25, 3:05 PM · Documentation, BF Blender

Sun, Feb 24

Chris Evans (mgchris) created T61902: Documentation for building Blender with Xcode doesn't work.
Sun, Feb 24, 7:05 AM · Documentation

Fri, Feb 22

Aaron Carlisle (Blendify) added a comment to T61848: Path to preferences is wrong in the help documentation.

This is fine, this is more of a known issue. Hopefully soon I will have time again to work on this.

Fri, Feb 22, 5:33 PM · Documentation
Dalai Felinto (dfelinto) closed T61848: Path to preferences is wrong in the help documentation as Archived.

Not sure we are taking reports on the outdated manual. There are plenty of things there that are outdated. The images for instance.
@Aaron Carlisle (Blendify) I closed this, feel free to open if you think you want to keep track of those.

Fri, Feb 22, 3:28 PM · Documentation

Feb 14 2019

Tobias Heinke (TobiasH) added a comment to T51080: Blender Manual 404 page redesign .

So, I wrote the extension: a fragile patchwork of ways making the links absolute. Split between the template, the extension, the inline script.
The version is set to 'dev': that's bad for the old versions (solution: server redirect number to 'dev' , has to be updated every release, so no)
home links (/index) are not fixed, solutions: inline script loop over all 'A's; slow, thus bad for mobile
or maybe it can be done in the extension I'll try it *later.

Feb 14 2019, 8:20 PM · Documentation

Feb 13 2019

Yevgeny Makarov (jenkm) added a comment to T51172: Blender Documentation Roadmap.

Is there any chance to see the possibility of online editing? At least, with the most simplified features for small edits.

Feb 13 2019, 9:58 AM · Documentation
Yevgeny Makarov (jenkm) added a comment to T56342: FIle downloads: re-evaluate .

It seems easier not to use the .blend files in the manual at all. Тoo many problems.

  • not one of the current files will not work/look well in 2.8
  • license (contributor may upload something is not suitable)
  • security (py-files or other executable code)
  • and so on

There may be links to external files in the see more section, for example files from developers in release logs.

Feb 13 2019, 9:52 AM · Documentation

Feb 7 2019

Julien DUROURE (julien) closed D4082: Documentation for glTF 2.0 exporter.

Doc is now commit into documentation svn

Feb 7 2019, 10:54 AM · Documentation
Julien DUROURE (julien) accepted D4082: Documentation for glTF 2.0 exporter.
Feb 7 2019, 10:53 AM · Documentation

Feb 4 2019

blend-it (blend-it) added a comment to T42765: Italian translation (Blender UI and manual).

Grazie. Il manuale necessita di un bel po' di lavoro, se riesci a metterci mano sarebbe molto utile!

Feb 4 2019, 4:35 PM · Documentation, Translations

Feb 1 2019

Brecht Van Lommel (brecht) added a comment to T48096: New Wiki.

@Tuomo, note box removed.

Feb 1 2019, 5:15 PM · Documentation, Infrastructure: Websites
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

Glad that you like the result! Cheers for ye olde wiki! :-)

Feb 1 2019, 5:00 PM · Documentation, Infrastructure: Websites
Dan McGrath (dmcgrath) added a comment to T48096: New Wiki.

Let's consider this resolved then.

I have left a copy of the tarball in /root/en.blender.org.tar.bz2. Feel free to grab a copy (~5.5G). This contains the vhost docroot, the old txt only dumps, and the database dump.

I wouldn't know what to do with that file, I just imagined you had someplace to archive these kinds of things.

Feb 1 2019, 3:44 PM · Documentation, Infrastructure: Websites
Brecht Van Lommel (brecht) updated the task description for T48096: New Wiki.
Feb 1 2019, 3:40 PM · Documentation, Infrastructure: Websites