DocumentationProject
ActivePublic

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)

Similar to the Blender Module Owners, the Section Owners are responsible for a given section, reviewing patches for it, giving feedback and keeping up to date with Blender development in that area.

SectionSection Owners
Animation(none yet)
Composite Nodes(none yet)
Data System(none yet)
Editors(none yet)
Sequencer@Aaron Carlisle (Blendify)
Game Engine(none yet)
Getting Started(none yet)
Grease Pencil(none yet)
Modeling(none yet)
Modifiers(none yet)
Motion Tracking(none yet)
Physics(none yet)
Rendering(none yet)
Rigging(none yet)
User Preferences(none yet)
Images(none yet)
Pipeline@Francesco Siddi (fsiddi)
NOTE: Since the documentation project is still new, there are currently not many official Section Owners. If you are interested in becoming a Section Owner, please contact us on the bf-docboard mailing list.

Translations

For translations, we use Sphinx’s internationalization package. To get started see https://www.blender.org/manual/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

Yesterday

John Roper (johnroper100) updated subscribers of T50467: docs.blender.org website homepage.

That is the way it is set up in the Blender Web Assets so that would be a question for @Francesco Siddi (fsiddi) and @Pablo Vazquez (venomgfx). I will fix it and make a path though.

Thu, Jan 19, 12:37 PM · Documentation
Ethan Brierley (EthanBox) added a comment to T50467: docs.blender.org website homepage.

Why is the View Button in the blender manual box have black text instead of white?

Thu, Jan 19, 12:34 PM · Documentation
Alex Cham (alexcham) added a comment to T50467: docs.blender.org website homepage.

Good, but page already contains more than enough information to understand where you are and what to do. Propose to remove useless words & phrases

Thu, Jan 19, 11:44 AM · Documentation
John Roper (johnroper100) added a comment to T50467: docs.blender.org website homepage.

Which top bar?

Thu, Jan 19, 8:33 AM · Documentation
Dan McGrath (dmcgrath) added a comment to T50466: Relocation of the documention (final solution).

The idea has been floating around for a while (I think possible from Campbell and I discussing it?). Either way, I am obviously for the idea. A bit of the reasons I had last we discussed were security related more than anything. Here are some of the valid points that I could find that we've discussed in the past already, to try bring things into one place for us:

Thu, Jan 19, 7:51 AM · Infrastructure: Websites, Documentation
Aaron Carlisle (Blendify) added a comment to T50467: docs.blender.org website homepage.

It is a good start, the top bar should be universal though. We should also add a "documentation" to the top bar to give more traffic to this page.

Thu, Jan 19, 4:19 AM · Documentation
John Roper (johnroper100) added a comment to T50466: Relocation of the documention (final solution).

Here is the design I am working on. T50467

Thu, Jan 19, 3:46 AM · Infrastructure: Websites, Documentation
John Roper (johnroper100) created T50467: docs.blender.org website homepage.
Thu, Jan 19, 3:44 AM · Documentation
Aaron Carlisle (Blendify) added a comment to T50466: Relocation of the documention (final solution).

That would be helpful thank you John

Thu, Jan 19, 12:17 AM · Infrastructure: Websites, Documentation

Wed, Jan 18

John Roper (johnroper100) added a comment to T50466: Relocation of the documention (final solution).

I would be willing to design a home page for it using the Blender web assets.

Wed, Jan 18, 11:19 PM · Infrastructure: Websites, Documentation
Aaron Carlisle (Blendify) created T50466: Relocation of the documention (final solution).
Wed, Jan 18, 10:20 PM · Infrastructure: Websites, Documentation
Aaron Carlisle (Blendify) triaged T50464: Move content from wiki to manual as "Normal" priority.
Wed, Jan 18, 9:32 PM · Documentation
Aaron Carlisle (Blendify) created T50464: Move content from wiki to manual.
Wed, Jan 18, 9:32 PM · Documentation
Alex Cham (alexcham) added a watcher for Documentation: Alex Cham (alexcham).
Wed, Jan 18, 6:23 AM

Tue, Jan 17

Aaron Carlisle (Blendify) closed T48318: Multiple mirror docs as "Resolved".
Tue, Jan 17, 4:24 AM · Documentation

Sun, Jan 8

eroMoD (tostrong4you) closed T50389: Documentation Project as "Resolved".

Oh, alright then

Sun, Jan 8, 3:57 AM · Documentation
John Roper (johnroper100) added a comment to T50389: Documentation Project.

I surprisingly actually have. I downloaded it, converted to pdf and then but it on my e-reader. Again, it is a reference about how the buttons work, not how to use the buttons to make something.

Sun, Jan 8, 3:32 AM · Documentation
eroMoD (tostrong4you) added a comment to T50389: Documentation Project.

Its definitely long and hard to read, ever read it?

Sun, Jan 8, 3:26 AM · Documentation
John Roper (johnroper100) added a comment to T50389: Documentation Project.

Hi, thanks for all your comments. You have some great ideas but like others have said, the manual is supposed to be a reference that you can go and find out quickly how a particular feature works. Because Blender is such a big program, the manual is already huge and I think that adding any extra content with make it harder to maintain and read.

Sun, Jan 8, 2:28 AM · Documentation

Sat, Jan 7

eroMoD (tostrong4you) created T50389: Documentation Project.
Sat, Jan 7, 7:45 PM · Documentation

Mon, Jan 2

Aaron Carlisle (Blendify) claimed T50355: Unsquared roughness of some shaders.
Mon, Jan 2, 1:51 AM · Documentation
Vilko Lafliksyon (Eranekao) created T50355: Unsquared roughness of some shaders.
Mon, Jan 2, 1:28 AM · Documentation

Sat, Dec 31

Aaron Carlisle (Blendify) added a comment to T50342: Spanish translation.

Did it give an error message? Make sure that sphinx is installed correctly. If you want to talk I am usually available in the #blenderwiki channel on IRC.
For more information on IRC see https://wiki.blender.org/index.php/Community:Chat

Sat, Dec 31, 5:01 AM · Documentation
marcal mora (blendercat) added a comment to T50342: Spanish translation.

Hi Aaron, I read the page a few hours ago but it was impossible to be continue after the page name . the make,bat don't run ok or i didn't know how to convert rst files to html.
The next order/place " blender_docs\build\html" doesn't exist in my pc, the build folder isn't have been create.
Which is the next step?

Sat, Dec 31, 1:19 AM · Documentation
Aaron Carlisle (Blendify) added a comment to T50342: Spanish translation.

To get started you are going to want to read over https://www.blender.org/manual/about/index.html
and get the manual and translations working on your computer.

Sat, Dec 31, 12:10 AM · Documentation

Fri, Dec 30

marcal mora (blendercat) created T50342: Spanish translation.
Fri, Dec 30, 11:34 PM · Documentation

Thu, Dec 29

Aaron Carlisle (Blendify) added a task to D2384: Script to automatically update rna_manual_reference.py: T49786: Purposal for the Context Sensitive Manual Access Tool.
Thu, Dec 29, 5:25 PM · Documentation, BF Blender
Aaron Carlisle (Blendify) added a revision to T49786: Purposal for the Context Sensitive Manual Access Tool: D2384: Script to automatically update rna_manual_reference.py.
Thu, Dec 29, 5:25 PM · Documentation, BF Blender

Dec 16 2016

Aaron Carlisle (Blendify) edited Description on Documentation.
Dec 16 2016, 4:51 AM
Aaron Carlisle (Blendify) edited Description on Documentation.
Dec 16 2016, 4:48 AM

Dec 7 2016

Francesco Siddi (fsiddi) edited Description on Documentation.
Dec 7 2016, 6:32 PM

Dec 6 2016

Aaron Carlisle (Blendify) added a comment to T48742: UI Naming Convention.

@Julian Eisel (Severin) I will be closing this soon. Do you think this should go on the wiki somewhere? Is so then where?

Dec 6 2016, 9:54 PM · Documentation
Aaron Carlisle (Blendify) closed T49995: Manual: add a note about missing privileges for running the External Image Editor as "Resolved" by committing rBM3020: Fix T49995 add a note about missing privileges for running the External Image….
Dec 6 2016, 9:17 PM · Documentation, BF Blender
Aaron Carlisle (Blendify) closed T42947: Composite Nodes out of date as "Resolved".
Dec 6 2016, 8:59 PM · Documentation
Aaron Carlisle (Blendify) closed T43469: Document Missing Nodes as "Resolved".
Dec 6 2016, 8:59 PM · Documentation
Aaron Carlisle (Blendify) closed T43469: Document Missing Nodes, a subtask of T42947: Composite Nodes out of date, as "Resolved".
Dec 6 2016, 8:59 PM · Documentation
Aaron Carlisle (Blendify) added a comment to T43469: Document Missing Nodes.

Thanks to everyone who helped with this! All nodes now have some level of documentation. We can now work on improving the quality of the text and adding some nice examples.

Dec 6 2016, 8:18 PM · Documentation
Aaron Carlisle (Blendify) placed T43469: Document Missing Nodes up for grabs.
Dec 6 2016, 8:12 PM · Documentation
Aaron Carlisle (Blendify) edited the description of T43469: Document Missing Nodes.
Dec 6 2016, 6:21 PM · Documentation
Aaron Carlisle (Blendify) edited the description of T43469: Document Missing Nodes.
Dec 6 2016, 6:15 PM · Documentation
Aaron Carlisle (Blendify) edited the description of T43469: Document Missing Nodes.
Dec 6 2016, 3:35 AM · Documentation

Dec 5 2016

Aaron Carlisle (Blendify) closed T50058: Manual: Boolean Modifier - Mistake about Conjunction/Disjunction as "Resolved" by committing rBM2996: Fix T50058 Boolean Modifier - Mistake about Conjunction/Disjunction.
Dec 5 2016, 11:56 PM · Documentation
Aaron Carlisle (Blendify) closed T50058: Manual: Boolean Modifier - Mistake about Conjunction/Disjunction, a subtask of T42896: Rewrite/Improve Boolean Modifier Page, as "Resolved".
Dec 5 2016, 11:56 PM · Documentation

Dec 4 2016

Aaron Carlisle (Blendify) closed T50182: typo in grease pencil intro doc as "Resolved" by committing rBM2990: Fix T50182 typo in grease pencil intro doc.
Dec 4 2016, 9:21 PM · Documentation
Aaron Carlisle (Blendify) claimed T50182: typo in grease pencil intro doc.
Dec 4 2016, 6:44 PM · Documentation
Christopher BEnnage (bennage) created T50182: typo in grease pencil intro doc.
Dec 4 2016, 6:09 PM · Documentation

Dec 1 2016

Aaron Carlisle (Blendify) planned changes to D2384: Script to automatically update rna_manual_reference.py.

The logic is not valid and has some corner cases.

Dec 1 2016, 7:01 PM · Documentation, BF Blender
Sergey Sharybin (sergey) added a member for Documentation: Yevgeny Makarov (jenkm).
Dec 1 2016, 3:18 PM
Sergey Sharybin (sergey) closed T49777: SVN Error - Filesystem is corrupt as "Resolved".

New ports arrived to FreeBSD 2016Q4 today and were installed now. Meaning, the issue is finally solved!

Dec 1 2016, 2:39 PM · Documentation

Nov 30 2016

Aaron Carlisle (Blendify) added a member for Documentation: MinSu Kim (kyjelblue).
Nov 30 2016, 2:56 AM