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

Yesterday

Aaron Carlisle (Blendify) closed T51557: Join the Translations project as "Resolved".

I am going to close this just so that it does not show up on my todo list but feel free to still use it as a line of communication. I have seen that you have been on IRC a couple of times but I have always been away/sleeping.

Tue, May 23, 9:35 PM · Documentation, BF Blender, Translations
Aaron Carlisle (Blendify) closed T51598: Documentation error as "Resolved" by committing rBM3558: Fix T51598: small typo.
Tue, May 23, 7:42 PM · Documentation
William Schilthuis (williamgs) created T51598: Documentation error.
Tue, May 23, 7:32 PM · Documentation

Sun, May 21

Aaron Carlisle (Blendify) added a member for Documentation: Alexander Gavrilov (angavrilov).
Sun, May 21, 6:56 PM

Fri, May 19

Aaron Carlisle (Blendify) closed T51471: Sphinx 1.6: use sphinx.ext.imgconverter as "Resolved".

Done in rBM3538

Fri, May 19, 10:47 PM · Documentation
zdy (NGENNGT) added a comment to T51557: Join the Translations project.

@YeHaike (YeHaike) There is an Manual Translation Team in Blendercn community, Would you like to join us? If the answer is yes, please join QQ group 620831153.

Fri, May 19, 4:08 PM · Documentation, BF Blender, Translations
Aaron Carlisle (Blendify) added a comment to T51557: Join the Translations project.

@YeHaike (YeHaike) I added you to the documentation project so you now have commit access to both the English and translation repositories. The credentials are kept in sync with whatever you used on this site.

Fri, May 19, 2:59 PM · Documentation, BF Blender, Translations
Aaron Carlisle (Blendify) added a member for Documentation: YeHaike (YeHaike).
Fri, May 19, 2:57 PM
Bastien Montagne (mont29) added projects to T51557: Join the Translations project: Translations, BF Blender, Documentation.

@YeHaike (YeHaike) Please note that translating Blender itself and translating its documentation are rather different processes. Will let documentation to @Aaron Carlisle (Blendify).

Fri, May 19, 12:24 PM · Documentation, BF Blender, Translations

Tue, May 16

Aaron Carlisle (Blendify) closed T51114: PyAPI: Problem to compile API (sphinx_doc_gen.**) as "Resolved".

Ok closing.

Tue, May 16, 8:47 PM · Documentation, Python, BF Blender

Mon, May 15

Brecht Van Lommel (brecht) added a comment to T51505: There are no page up or page down keys on a Mac laptop..

Fn + Up and Fn + Down work as Page Up and Page Down keys in all applications on macOS.

Mon, May 15, 10:47 PM · Documentation
Sebastian Koenig (sebastian_k) closed T51505: There are no page up or page down keys on a Mac laptop. as "Invalid".

Sorry, but this isn't a valid bug. It is more a problem with your keyboard. Hardware limitations cannot be addressed by the Blender Developers.
Instead, you could easily change the hotkeys for your setup.

Mon, May 15, 8:56 PM · Documentation
Leo Treasure (leotreasure) created T51505: There are no page up or page down keys on a Mac laptop..
Mon, May 15, 5:31 PM · Documentation

Thu, May 11

Ray Mairlot (madog) added a comment to T51472: Remove gif images.

The correct tagging of information allows said information to be accurately searched, which from a user perspective is important to be able to find existing bugs to prevent reporting duplicates. Personally, I would also think it's important from a developer perspective to make sure the ever important bug list is not populated with things which aren't bugs, but then I'm not a developer. I'd say this sounds more like a task, but if you're saying it's a bug, fair enough.

Thu, May 11, 11:46 PM · Documentation
Aaron Carlisle (Blendify) added a comment to T51472: Remove gif images.

I do not think it really matters but I would say it is a bug as it causes issues with pdf generation.

Thu, May 11, 11:37 PM · Documentation
Ray Mairlot (madog) added a comment to T51472: Remove gif images.

Is this meant to be tagged as a bug?

Thu, May 11, 11:21 PM · Documentation
Aaron Carlisle (Blendify) triaged T51473: API: images, use external image with sphinx 1.6 as "Normal" priority.
Thu, May 11, 6:46 PM · Python, Documentation
Aaron Carlisle (Blendify) triaged T51471: Sphinx 1.6: use sphinx.ext.imgconverter as "Normal" priority.
Thu, May 11, 6:43 PM · Documentation
Aaron Carlisle (Blendify) created T51472: Remove gif images.
Thu, May 11, 6:24 PM · Documentation
Aaron Carlisle (Blendify) changed Type from Bug to To Do on T51471: Sphinx 1.6: use sphinx.ext.imgconverter.
Thu, May 11, 6:19 PM · Documentation
Aaron Carlisle (Blendify) added a project to T51471: Sphinx 1.6: use sphinx.ext.imgconverter: Documentation.
Thu, May 11, 6:19 PM · Documentation

Tue, May 9

Aaron Carlisle (Blendify) renamed T51061: Collection of bad/missing tooltips from "Collection of bad tooltips" to "Collection of bad/missing tooltips".
Tue, May 9, 8:49 PM · Translations, Documentation, User Interface, BF Blender
Aaron Carlisle (Blendify) added a member for Documentation: Jürgen Tschandl (JuergenT).
Tue, May 9, 4:41 AM

Fri, May 5

Aaron Carlisle (Blendify) assigned T51387: Macro (bpy.types.Macro) needs proper documentation to Campbell Barton (campbellbarton).
Fri, May 5, 12:10 AM · Python, Documentation

Tue, May 2

dima glib (dairin0d) created T51387: Macro (bpy.types.Macro) needs proper documentation.
Tue, May 2, 5:09 AM · Python, Documentation

Sun, Apr 30

Josberth (SirComand) added a watcher for Documentation: Josberth (SirComand).
Sun, Apr 30, 7:31 PM

Fri, Apr 28

Taeho Yoon (Ubuntunux) added a watcher for Documentation: Taeho Yoon (Ubuntunux).
Fri, Apr 28, 8:58 AM

Tue, Apr 25

Aaron Carlisle (Blendify) added a member for Documentation: Jack Liu (jacknlliu).
Tue, Apr 25, 2:52 AM

Apr 19 2017

Aaron Carlisle (Blendify) updated subscribers of T51172: Blender Documentation Roadmap.
Apr 19 2017, 5:14 PM · Documentation
Aaron Carlisle (Blendify) changed Type from Bug to To Do on T51061: Collection of bad/missing tooltips.
Apr 19 2017, 6:07 AM · Translations, Documentation, User Interface, BF Blender

Apr 14 2017

Aaron Carlisle (Blendify) closed T43083: Translations (how to handle, design task) as "Resolved".

Marking as resolved, for the most part, we have the workflow together. If people are interested in joining the project please follow the steps on Documentation and email the mailing list.

Apr 14 2017, 9:22 PM · Documentation

Apr 13 2017

Aaron Carlisle (Blendify) edited the description of T51061: Collection of bad/missing tooltips.
Apr 13 2017, 8:22 PM · Translations, Documentation, User Interface, BF Blender
Aaron Carlisle (Blendify) added a comment to T51061: Collection of bad/missing tooltips.

Some more bad tooltips can be found here: https://wiki.blender.org/index.php/Dev:Ref/Proposals/UI/Tooltips#Tooltip_and_Infotip_Suggestions

Apr 13 2017, 8:20 PM · Translations, Documentation, User Interface, BF Blender
Aaron Carlisle (Blendify) added inline comments to D2621: API Docs: Add html logo.
Apr 13 2017, 6:41 PM · Python, BF Blender, Documentation
Aaron Carlisle (Blendify) created D2621: API Docs: Add html logo.
Apr 13 2017, 6:39 PM · Python, BF Blender, Documentation
Aaron Carlisle (Blendify) closed T50724: Add note to blender Manual: Color picker RGB is not gamma corrected as "Resolved" by committing rBM3502: Fix T50724: Add note to blender Manual: Color picker RGB is not gamma corrected.
Apr 13 2017, 7:19 AM · Documentation
Aaron Carlisle (Blendify) closed T49823: Broken links on "Spot Buffered Shadows" page as "Archived".

I decided to just archive this. The blender internal will be removed in 2.8 at it is not worth it.

Apr 13 2017, 6:03 AM · Documentation

Apr 11 2017

Aaron Carlisle (Blendify) created T51172: Blender Documentation Roadmap.
Apr 11 2017, 5:56 AM · Documentation
Aaron Carlisle (Blendify) closed T50466: Relocation of the documention (final solution) as "Resolved".

Thanks for everyone who helped move this over.

Apr 11 2017, 5:52 AM · Infrastructure: Websites, Documentation
Aaron Carlisle (Blendify) closed T51081: Swap <version> and <lang> in the manual url as "Archived".

Talked on IRC a bit more. While swapping them would give nice benefits we decided to go with the standard.

Apr 11 2017, 5:50 AM · Documentation
Aaron Carlisle (Blendify) moved T51061: Collection of bad/missing tooltips from Backlog to Blender 2.8: Tools on the User Interface board.
Apr 11 2017, 5:43 AM · Translations, Documentation, User Interface, BF Blender

Apr 10 2017

zdy (NGENNGT) closed T51160: inconsistency between the manual and latest UI for stroke edit mode access as "Resolved".

Got it! I've modified the manual to be:

Apr 10 2017, 8:33 AM · Documentation

Apr 9 2017

Tobias Heinke (TobiasH) added a comment to T51160: inconsistency between the manual and latest UI for stroke edit mode access.

Actually this button is shown in the 2D editors (UV-Image editor, Node editor, etc.), once a stroke is drawn.
So this just has to be clarified as additional info in brackets.

Apr 9 2017, 7:26 PM · Documentation
zdy (NGENNGT) created T51160: inconsistency between the manual and latest UI for stroke edit mode access.
Apr 9 2017, 7:18 PM · Documentation
Ulysse Martin (youle) added a comment to T51114: PyAPI: Problem to compile API (sphinx_doc_gen.**).

There's a new version of sphinx (1.5.5) which seems to fix the issue. I don't know if all the documentation is compiled but the issue seems fixed. I let you test, confirm and close if this is ok for you. Bye!

Apr 9 2017, 3:34 PM · Documentation, Python, BF Blender

Apr 7 2017

Ulysse Martin (youle) edited the description of T51114: PyAPI: Problem to compile API (sphinx_doc_gen.**).
Apr 7 2017, 8:39 PM · Documentation, Python, BF Blender

Apr 4 2017

Aaron Carlisle (Blendify) assigned T51114: PyAPI: Problem to compile API (sphinx_doc_gen.**) to Campbell Barton (campbellbarton).
Apr 4 2017, 9:00 PM · Documentation, Python, BF Blender

Apr 3 2017

Francesco Siddi (fsiddi) added a comment to T51080: Blender Manual 404 page redesign .

I see your updates.
Just a heads up that as soon as I get a moment I'll update that page myself, so you can get a better idea of what I mean.

Apr 3 2017, 3:54 PM · Documentation
blend-it (blend-it) added a project to T51061: Collection of bad/missing tooltips: Translations.

Useful for avoid this kind of changes become a nightmare for far-to-be-completed UI translations... :)

Apr 3 2017, 3:16 PM · Translations, Documentation, User Interface, BF Blender
Aaron Carlisle (Blendify) edited the description of T51061: Collection of bad/missing tooltips.
Apr 3 2017, 4:14 AM · Translations, Documentation, User Interface, BF Blender