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

Inês Almeida (brita_) updated the task description for T48096: New Wiki.
Sat, Dec 15, 9:43 PM · Documentation, Infrastructure: Websites
Inês Almeida (brita_) added a comment to T56342: FIle downloads: re-evaluate .

@Sergey Sharybin (sergey) why do you think the licensing rule is strict?
A public domain diagram of an algorithm can be uploaded with its original license and author if needed. I think public domain, other versions of CC and the licenses used in the previous Blender wiki are all perfectly fine.
The Blender Cloud says: "Unless notified otherwise, all digital content (webpages, video, artwork, 3D data) is available under the Creative Commons Attribution 4.0.". Blender Cloud textures are CC0. So these can also be uploaded with their original license.

Sat, Dec 15, 5:55 PM · Documentation
Sergey Sharybin (sergey) added a comment to T56342: FIle downloads: re-evaluate .

@Inês Almeida (brita_), i am all for keeping things locally in terms where they belong to. Makes it easier to version, control consistency, and see where they actually are supposed to be put.

Sat, Dec 15, 5:33 PM · Documentation
Inês Almeida (brita_) added a comment to D4015: Use of upper and lower case letters in Blender Manual.

I am very sorry to hear this. I am also sorry that I took over a week replying.
Please don't be discouraged by feedback or by people disagreeing, it only means that people care.
Specially with text, there can be endless discussions about wording and commas which can be frustrating.
Maybe you picked controversial topics? Can you give a second try to writing new content? With 2.8 there are exciting new opportunities to write entirely new chapters about Grease Pencil Object layers, groups and visibility.
The Blender documentation needs *you* :)

Sat, Dec 15, 5:31 PM · Documentation
Inês Almeida (brita_) updated subscribers of T56342: FIle downloads: re-evaluate .

It's been some time without a reply.
@Sergey Sharybin (sergey) @Campbell Barton (campbellbarton) do you have anything against putting media files in the manual SVN under a new files/ folder in the root directory?

Sat, Dec 15, 4:55 PM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to D4015: Use of upper and lower case letters in Blender Manual.

thanks for your comment! Yes I abandoned my remaining few open tasks related to Blender Manual. My work during last month on Blender Manual has received mostly negative feedback and only few positive comments. I concluded that it is best for me to work on something else.

Sat, Dec 15, 4:26 PM · Documentation
Brecht Van Lommel (brecht) added a comment to T51172: Blender Documentation Roadmap.

Yeah sure, except for "incrementally make changes" it's doesn't works and likely ends up in a mess.

Sat, Dec 15, 3:55 PM · Documentation
Inês Almeida (brita_) added a comment to T51172: Blender Documentation Roadmap.

@Tuomo Keskitalo (tkeskita) I tend to agree with the other comments.
Updating the manual to 2.8 is already a huge task and I don't think it's very realistic to restructure it at the same time.
It would already be wonderful if you would pick up one section for something that is new or completely changed and make sure that's well documented.
Try the grease pencil! This is a very popular area that people are beginning to experiment with, including people who are totally new to Blender. It would be great to have official docs for it and a list of handpicked video tutorials to see different workflows and what can be achieved.

Sat, Dec 15, 3:14 PM · Documentation
Inês Almeida (brita_) added a comment to T48381: Move old release logs to the wiki.

Hey @Aaron Carlisle (Blendify) can this be closed?

Sat, Dec 15, 2:48 PM · Documentation
Inês Almeida (brita_) added a comment to D4015: Use of upper and lower case letters in Blender Manual.

Hi @Tuomo Keskitalo (tkeskita) you seemed to have abandoned the revisions to improve the clarity of the rules for writing the Blender Manual.
Is there a problem? It think it was a really good effort!

Sat, Dec 15, 1:01 PM · Documentation
Julien DUROURE (julien) added a reviewer for D4082: Documentation for glTF 2.0 exporter: Aaron Carlisle (Blendify).

@Aaron Carlisle (Blendify) : I don't know exactly how documentation repo is managed. Can you please review this documentation page for glTF importer/exporter?
Is it possible to have commit access on the repo to be able to update this page later ?

Sat, Dec 15, 8:38 AM · Documentation

Fri, Dec 14

Don McCurdy (donmccurdy) created D4082: Documentation for glTF 2.0 exporter.
Fri, Dec 14, 11:18 PM · Documentation
Brecht Van Lommel (brecht) added a member for Documentation: Richard Antalik (ISS).
Fri, Dec 14, 2:54 PM

Wed, Dec 12

Tuomo Keskitalo (tkeskita) removed a watcher for Documentation: Tuomo Keskitalo (tkeskita).
Wed, Dec 12, 7:36 PM
Tuomo Keskitalo (tkeskita) abandoned D4052: Blender Manual automatic Title Case correction example.
Wed, Dec 12, 7:34 PM · Documentation
Tuomo Keskitalo (tkeskita) abandoned D3915: rBM 2.80 upgrade, section User Interface - Window System - Tabs and Panels.
Wed, Dec 12, 7:32 PM · Documentation
Tuomo Keskitalo (tkeskita) abandoned D4041: Blender Manual Markup Guide, image instructions.
Wed, Dec 12, 7:32 PM · Documentation
Tuomo Keskitalo (tkeskita) abandoned D3916: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Buttons.
Wed, Dec 12, 7:31 PM · Documentation
Tuomo Keskitalo (tkeskita) abandoned D4015: Use of upper and lower case letters in Blender Manual.
Wed, Dec 12, 7:31 PM · Documentation
Tuomo Keskitalo (tkeskita) abandoned D4045: Blender Manual Writing Guide renewal proposal.
Wed, Dec 12, 7:30 PM · Documentation
Bastien Montagne (mont29) closed T59213: Application menu links to outdated version of Python API as Resolved by committing rB047d7d3b57c0: Fix T59213: Application menu links to outdated version of Python API..
Wed, Dec 12, 12:04 PM · Documentation, BF Blender
Bastien Montagne (mont29) claimed T59213: Application menu links to outdated version of Python API.

Those are old names, should have been changed to new ones. ;)

Wed, Dec 12, 11:54 AM · Documentation, BF Blender
Tobias Heinke (TobiasH) requested changes to D4045: Blender Manual Writing Guide renewal proposal.

I could add a comment to almost ever single line (Why are you: altering the meaning, remove examples/explanations, the reshuffling, removal of rules..)
You're turning it into a cheat sheet.
Yes, it improves the wording. I'm sorry but your not experienced enough (yet) to rewrite the guide.

Wed, Dec 12, 12:04 AM · Documentation

Tue, Dec 11

Tobias Heinke (TobiasH) added a comment to T51172: Blender Documentation Roadmap.

Yeah sure, except for "incrementally make changes" it's doesn't works and likely ends up in a mess.
We already have the Data System section for scences, etc.
Moving Grease Pencil is part of 2.8.

Tue, Dec 11, 11:15 PM · Documentation
Benjamin Humpherys (brhumphe) added a project to T59213: Application menu links to outdated version of Python API: Documentation.
Tue, Dec 11, 10:17 PM · Documentation, BF Blender
Benjamin Humpherys (brhumphe) added a comment to T48096: New Wiki.

Does the wiki log whenever someone tries to visit a missing page? That would be a good way to identify broken links.

Tue, Dec 11, 8:36 PM · Documentation, Infrastructure: Websites
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

Uh oh, there are some lonesome island pages in the old wiki which are never linked to --> recursive wget did not find them. I need to do new retrieval with this pagelist. Maybe no need for acrobatics.. but this will take time.

Tue, Dec 11, 8:10 PM · Documentation, Infrastructure: Websites
Brecht Van Lommel (brecht) added a comment to D4045: Blender Manual Writing Guide renewal proposal.

Seems all reasonable to me, but would be good if someone more active in the manual would look at this.

Tue, Dec 11, 8:08 PM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

Thanks, found em! There was a file which seems to list each page and links from it to other pages, which I hope I can use. Currently it looks mildly painful though, some relative path acrobatics is needed..

Tue, Dec 11, 7:51 PM · Documentation, Infrastructure: Websites

Mon, Dec 10

Tobias Heinke (TobiasH) added a comment to D4015: Use of upper and lower case letters in Blender Manual.

No, I don't have a reference for that; other than other programs of similar type/scale *cough GIMP ;).
The problem where to end: all upper for editors, modifiers, constraints, but not for other UI's (menus, panels, nodes).
With all upper we would end up with all words uppercase in some sentences.

Mon, Dec 10, 11:16 PM · Documentation
Dan McGrath (dmcgrath) added a comment to T48096: New Wiki.
@fsiddi : Thanks, I'll do that! I briefly tested that it indeed seems to fix the icon issue.

So the biggest issue still standing is the missing of some redirected directories. @Dan McGrath (dmcgrath) : Where is this mediawiki xml dump? I could maybe take a look at it. Thanks!

Mon, Dec 10, 8:26 PM · Documentation, Infrastructure: Websites
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

@Francesco Siddi (fsiddi) : Thanks, I'll do that! I briefly tested that it indeed seems to fix the icon issue.

Mon, Dec 10, 8:03 PM · Documentation, Infrastructure: Websites
Francesco Siddi (fsiddi) added a comment to T48096: New Wiki.

Hi Tuomo. First off, great work with the wiki baking. Thank you for your help with this!

Mon, Dec 10, 9:01 AM · Documentation, Infrastructure: Websites
Aaron Carlisle (Blendify) added a reviewer for D4045: Blender Manual Writing Guide renewal proposal: Aaron Carlisle (Blendify).
Mon, Dec 10, 3:18 AM · Documentation
Aaron Carlisle (Blendify) accepted D4052: Blender Manual automatic Title Case correction example.
Mon, Dec 10, 3:15 AM · Documentation
Brecht Van Lommel (brecht) added a comment to T51172: Blender Documentation Roadmap.

I don't think it's a good idea to move all the editor docs under workspaces. This is a reference manual, where ideally things are in a predictable place for looking up. It's not so much a book or tutorial that you follow. Since editors don't clearly map to a single workspace / tasks, I don't think it's a good fit. The default workspaces are also just presets, which users can change.

Mon, Dec 10, 1:10 AM · Documentation

Sun, Dec 9

Tobias Heinke (TobiasH) added a comment to T51172: Blender Documentation Roadmap.

But a script needs instructions, it's the planning that's costs precious time.
It would take 1 person 2 month full time to plan, test, apply this.
2.8 1 person 2 years full time at current speed 5 years (very vague).

Sun, Dec 9, 11:05 PM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to T51172: Blender Documentation Roadmap.

@Tobias Heinke (TobiasH) Would you reconsider this if I can come up with a script that does the restructuring of rst files?

Sun, Dec 9, 7:29 AM · Documentation
Tobias Heinke (TobiasH) added inline comments to D3916: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Buttons.
Sun, Dec 9, 2:20 AM · Documentation

Sat, Dec 8

Tobias Heinke (TobiasH) added inline comments to D4041: Blender Manual Markup Guide, image instructions.
Sat, Dec 8, 11:37 PM · Documentation
Tobias Heinke (TobiasH) added a comment to T51172: Blender Documentation Roadmap.

Yes, the current structure is mix of UI based (editors) and the production pipeline ("workspaces") - it's best of two worlds.
To be honest I have to reject this directly and even a more in-depth discussion:
We are too few people to handle such mayor restructurizations.
2.8 is enough a 'challenge' (euphemistically) on it's own.

Sat, Dec 8, 10:30 PM · Documentation
Tobias Heinke (TobiasH) added a comment to D3925: rBM 2.80 upgrade, section User Interface - Window System - Buttons - Numbers.

But 3 words "numeric input fields" are too long. Especially when it's a specific one like 'the X rotation numeric input field'.
Does just 'numeric field' works in the English? That would also be consistent with 'text/ search field'.

Sat, Dec 8, 9:11 PM · Documentation
Tuomo Keskitalo (tkeskita) updated subscribers of T51172: Blender Documentation Roadmap.

Hi, I have been thinking about Blender 2.8 Manual structure, and I'd like to hear your comments on this idea. @Aaron Carlisle (Blendify), @Francesco Siddi (fsiddi), @Brecht Van Lommel (brecht), @Tobias Heinke (TobiasH) , @Inês Almeida (brita_) , anyone else?

Sat, Dec 8, 4:30 PM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to D4015: Use of upper and lower case letters in Blender Manual.

If we choose to go with this Title Case style requirement, I think that the correction work would be made easier by using a find-replace bash command. D4052 shows an example for "Edit Mode". I'm sure its not perfect, but it seems to catch quite a few.

Sat, Dec 8, 8:04 AM · Documentation
Tuomo Keskitalo (tkeskita) created D4052: Blender Manual automatic Title Case correction example.
Sat, Dec 8, 7:55 AM · Documentation

Fri, Dec 7

Tuomo Keskitalo (tkeskita) created D4045: Blender Manual Writing Guide renewal proposal.
Fri, Dec 7, 12:54 PM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to D4015: Use of upper and lower case letters in Blender Manual.

It's also to connect words Operator Panel vs. Transform panel (one of many panels).

Fri, Dec 7, 9:21 AM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

The icon problem does not seem to be related to those three removed lines I mention in T48096#571067:

Fri, Dec 7, 8:22 AM · Documentation, Infrastructure: Websites
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

If you go to http://tkeskita.kapsi.fi/temp/en.blender.org/index.php/Dev:Ref/GSoC.1.html and check the very last link 'Getting Started' it doesn't match the target of the same link on https://en.blender.org/index.php/Dev:Ref/GoogleSummerOfCode
I can see that the target page https://en.blender.org/index.php/Dev:Ref/GoogleSummerOfCode/Getting_Started was moved. Maybe that is what is causing the issue.

Fri, Dec 7, 7:30 AM · Documentation, Infrastructure: Websites
Inês Almeida (brita_) added a comment to D4041: Blender Manual Markup Guide, image instructions.

I think this is a great step in the right direction!
Some nitpicks included.

Fri, Dec 7, 12:15 AM · Documentation