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

Wed, Apr 19

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

Fri, Apr 14

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.

Fri, Apr 14, 9:22 PM · Documentation

Thu, Apr 13

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

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

Thu, Apr 13, 8:20 PM · Translations, Documentation, User Interface, BF Blender
Aaron Carlisle (Blendify) added inline comments to D2621: API Docs: Add html logo.
Thu, Apr 13, 6:41 PM · Python, BF Blender, Documentation
Aaron Carlisle (Blendify) created D2621: API Docs: Add html logo.
Thu, Apr 13, 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.
Thu, Apr 13, 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.

Thu, Apr 13, 6:03 AM · Documentation

Tue, Apr 11

Aaron Carlisle (Blendify) created T51172: Blender Documentation Roadmap.
Tue, Apr 11, 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.

Tue, Apr 11, 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.

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

Mon, Apr 10

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:

Mon, Apr 10, 8:33 AM · Documentation

Sun, Apr 9

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.

Sun, Apr 9, 7:26 PM · Documentation
zdy (NGENNGT) created T51160: inconsistency between the manual and latest UI for stroke edit mode access.
Sun, Apr 9, 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!

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

Fri, Apr 7

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

Tue, Apr 4

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

Mon, Apr 3

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.

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

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

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

Sun, Apr 2

Vuk Gardašević (lijenstina) added a comment to T51061: Collection of bad tooltips.

Operator Cheat Sheet doesn't have a tooltip at all.

Sun, Apr 2, 10:53 PM · Translations, Documentation, User Interface, BF Blender

Sat, Apr 1

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

Done some edits (random 404).
The links are important, since with a complex design and no external css, svg, js the page quickly turns into a maze.

Sat, Apr 1, 1:15 PM · Documentation
Tobias Heinke (TobiasH) added a comment to T51081: Swap <version> and <lang> in the manual url.

I changed my mind: Also language first is valid, because the language is common/static between the version. From this point of view it doesn't matter if xy is only offered since 2.78. And yes it makes no difference for the version switch (D 2544).
So if there are no benefits it would be better to use to the standard.

Sat, Apr 1, 12:58 PM · Documentation

Fri, Mar 31

John Roper (johnroper100) added a comment to T51081: Swap <version> and <lang> in the manual url.

I agree. I believe that usability trumps in this case.

Fri, Mar 31, 10:53 PM · Documentation
Aaron Carlisle (Blendify) added a comment to T51081: Swap <version> and <lang> in the manual url.

@Tobias Heinke (TobiasH) agrees that it should be swapped.

Fri, Mar 31, 10:50 PM · Documentation
Aaron Carlisle (Blendify) triaged T51081: Swap <version> and <lang> in the manual url as "Normal" priority.
Fri, Mar 31, 10:49 PM · Documentation
Aaron Carlisle (Blendify) triaged T47052: Physics Introduction needs a Rewrite as "Normal" priority.
Fri, Mar 31, 10:18 PM · Documentation
Tobias Heinke (TobiasH) edited Description on Documentation.
Fri, Mar 31, 4:45 PM
raja kedia (decoda) added a watcher for Documentation: raja kedia (decoda).
Fri, Mar 31, 8:52 AM

Wed, Mar 29

Aaron Carlisle (Blendify) edited the description of T51081: Swap <version> and <lang> in the manual url.
Wed, Mar 29, 7:22 PM · Documentation
Aaron Carlisle (Blendify) updated subscribers of T51081: Swap <version> and <lang> in the manual url.
Wed, Mar 29, 7:20 PM · Documentation
Sergey Sharybin (sergey) added a comment to T51081: Swap <version> and <lang> in the manual url.

Ok, as i see now dev refers to a version, not to a developer's manual (obviously).

Wed, Mar 29, 7:14 PM · Documentation
Francesco Siddi (fsiddi) added a comment to T51080: Blender Manual 404 page redesign .

We are talking about design here. Links are not relevant at this point of the discussion. I would like to see a design with good layout and typography first. Are you available to do it @Tobias Heinke (TobiasH) ?

Wed, Mar 29, 6:08 PM · Documentation
Tobias Heinke (TobiasH) added a comment to T51080: Blender Manual 404 page redesign .

The 404 page needs to be self contained, and to avoid broken links, absolute paths aren't an option.

Wed, Mar 29, 6:03 PM · Documentation
Aaron Carlisle (Blendify) created T51081: Swap <version> and <lang> in the manual url.
Wed, Mar 29, 5:51 PM · Documentation
Francesco Siddi (fsiddi) created T51080: Blender Manual 404 page redesign .
Wed, Mar 29, 5:33 PM · Documentation

Tue, Mar 28

Aaron Carlisle (Blendify) triaged T51061: Collection of bad tooltips as "Confirmed" priority.
Tue, Mar 28, 5:18 AM · Translations, Documentation, User Interface, BF Blender
Aaron Carlisle (Blendify) created T51061: Collection of bad tooltips.
Tue, Mar 28, 5:18 AM · Translations, Documentation, User Interface, BF Blender
Aaron Carlisle (Blendify) edited Description on Documentation.
Tue, Mar 28, 12:00 AM

Mon, Mar 27

Aaron Carlisle (Blendify) added a member for Documentation: Cheng Chia Tseng (zerng07).
Mon, Mar 27, 11:53 PM

Mar 24 2017

Aaron Carlisle (Blendify) closed T51045: grease pencil - minor improvement suggestion as "Resolved" by committing rBM3459: Fix T51045: Minor wording change to sound more positive.
Mar 24 2017, 12:37 AM · Documentation

Mar 23 2017

Sean Loughman (studiospring) added a watcher for Documentation: Sean Loughman (studiospring).
Mar 23 2017, 11:58 PM
Daniel M. Basso (dmbasso) created T51045: grease pencil - minor improvement suggestion.
Mar 23 2017, 9:14 PM · Documentation
Aaron Carlisle (Blendify) closed T51043: Fix links on wiki manual oage headers as "Archived".

Better not edit this. It requires editing the https://svn.blender.org/svnroot/blend-doc/trunk/ repo.

Mar 23 2017, 8:03 PM · Documentation
Aaron Carlisle (Blendify) created T51043: Fix links on wiki manual oage headers.
Mar 23 2017, 4:58 PM · Documentation

Mar 22 2017

Tobias Heinke (TobiasH) added a comment to T49262: Manual Versioning.

There is also: sphinxcontrib-versioning , but it doesn't support internationalization (languages). It would do the first method "auto build" as described above. I can't tell if it works with SVN, then it maybe can be used for the API.

Mar 22 2017, 2:47 PM · Infrastructure: Websites, Documentation

Mar 21 2017

gines capote (gingraphic) added a watcher for Documentation: gines capote (gingraphic).
Mar 21 2017, 9:36 PM