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.
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,
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).
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) updated the task description for T54147: sphinx_rtd_theme 2.5 todos.
Fri, Feb 23, 11:20 PM · Documentation
Aaron Carlisle (Blendify) created T54147: sphinx_rtd_theme 2.5 todos.
Fri, Feb 23, 11:20 PM · Documentation
Campbell Barton (campbellbarton) assigned T54139: Remove Spline IK roll description to Joshua Leung (aligorith).
Fri, Feb 23, 5:18 AM · Documentation
Rafael Navega (RN) created T54139: Remove Spline IK roll description.
Fri, Feb 23, 2:11 AM · Documentation

Tue, Feb 20

Aaron Carlisle (Blendify) added a comment to T51080: Blender Manual 404 page redesign .

I started on this in rBM4085 but there is still work to be done.
Do we want to add back all the javascript enable functionality? I find the following two tools useful:

Tue, Feb 20, 11:31 PM · Documentation

Mon, Feb 19

Tobias Heinke (TobiasH) triaged T54104: Softbody: dublication as Normal priority.
Mon, Feb 19, 5:01 PM · Documentation
stephen leger (stephen_leger) added a comment to T54097: Proposal: Addon documentation for 2.8.

Hi,
+1 for .rst documentation.

Mon, Feb 19, 2:53 AM · Documentation, Addons
Campbell Barton (campbellbarton) added a comment to T54097: Proposal: Addon documentation for 2.8.

While I like the idea of keeping the addon and it's docs in the same repo.
git + git+lfs are quite advanced / tricky to use.
So I'm not sure about depending on this.

Mon, Feb 19, 12:16 AM · Documentation, Addons

Sun, Feb 18

Aaron Carlisle (Blendify) added a comment to T51080: Blender Manual 404 page redesign .

@Francesco Siddi (fsiddi) what are your thoughts on the custom JavaScript/buttons

Sun, Feb 18, 11:56 PM · Documentation
Aaron Carlisle (Blendify) added a comment to T54097: Proposal: Addon documentation for 2.8.

I can provide a live example if needed.

Sun, Feb 18, 11:49 PM · Documentation, Addons
Aaron Carlisle (Blendify) updated the task description for T54097: Proposal: Addon documentation for 2.8.
Sun, Feb 18, 6:51 PM · Documentation, Addons
Aaron Carlisle (Blendify) updated subscribers of T54097: Proposal: Addon documentation for 2.8.
Sun, Feb 18, 6:48 PM · Documentation, Addons
Aaron Carlisle (Blendify) triaged T54097: Proposal: Addon documentation for 2.8 as Normal priority.
Sun, Feb 18, 6:45 PM · Documentation, Addons
Aaron Carlisle (Blendify) closed T53838: Link to "demo_file.zip" in chapter "Vehicle Controller Physics" of the user manual is broken. as Resolved by committing rBM4071: Fix T53838: Dead link to example -- remove.
Sun, Feb 18, 2:13 AM · Game Physics, Documentation
Aaron Carlisle (Blendify) closed T54062: wiki.blender.org links are redirecting to Blender Manual as Resolved.

The page now lives in the new location.

Sun, Feb 18, 2:12 AM · Documentation
Aaron Carlisle (Blendify) closed T53329: Stack traces are only available on linux and osMac (Not windows) as Resolved by committing rBM4070: Fix T53329 stack trace only on unix.
Sun, Feb 18, 2:08 AM · Documentation
Aaron Carlisle (Blendify) closed T53177: Documentation: Error in formula for specularity calculation hint as Resolved.

This has been fixed

Sun, Feb 18, 2:05 AM · Documentation
Aaron Carlisle (Blendify) closed T51472: Remove gif images as Resolved.

Committed rBM4069

Sun, Feb 18, 2:01 AM · Documentation

Thu, Feb 15

Aaron Carlisle (Blendify) added a comment to T51080: Blender Manual 404 page redesign .

It is simply just keeping the main RTD layout but overriding the content part to display 404 and provide some information to get to search, home, ect.

Thu, Feb 15, 5:01 PM · Documentation
Pablo Vazquez (venomgfx) added a comment to T51080: Blender Manual 404 page redesign .

Expect a solution for this from me soonish. Waiting for a couple upstream PRs to be merged. If we feel this to be more urgent I can use a branch of the theme.

Thu, Feb 15, 3:45 PM · Documentation
Aaron Carlisle (Blendify) claimed T51080: Blender Manual 404 page redesign .

Expect a solution for this from me soonish. Waiting for a couple upstream PRs to be merged. If we feel this to be more urgent I can use a branch of the theme.

Thu, Feb 15, 3:16 PM · Documentation

Wed, Feb 14

Aaron Carlisle (Blendify) moved T51080: Blender Manual 404 page redesign from Backlog to Administrative on the Documentation board.
Wed, Feb 14, 6:53 PM · Documentation
Aaron Carlisle (Blendify) moved T54062: wiki.blender.org links are redirecting to Blender Manual from Backlog to Administrative on the Documentation board.
Wed, Feb 14, 6:53 PM · Documentation

Tue, Feb 13

Aaron Carlisle (Blendify) added a comment to T54062: wiki.blender.org links are redirecting to Blender Manual.

P.S. If the wiki manual is no longer being supported that's fine. I just think that people who are browsing the wiki shouldn't get link off to the new manual when changing Blender versions (first new example).

Tue, Feb 13, 10:27 PM · Documentation
Christopher Anderssarian (Christopher_Anderssarian) added a comment to T54062: wiki.blender.org links are redirecting to Blender Manual.

Totally agree, I'm just wondering if the wiki manual can be fixed to work on it's own.

Tue, Feb 13, 9:30 PM · Documentation
Aaron Carlisle (Blendify) updated subscribers of T54062: wiki.blender.org links are redirecting to Blender Manual.

These redirects were set up a while ago and I do not find it reasonable to take the time to re-update to the exact locations in the new manual. I think other like @Campbell Barton (campbellbarton) would agree.

Tue, Feb 13, 8:31 PM · Documentation
Vuk Gardašević (lijenstina) added a comment to T54062: wiki.blender.org links are redirecting to Blender Manual.

Note i've created the wiki page for the add-on. so that issue should be addressed soon.

Tue, Feb 13, 6:28 PM · Documentation
Christopher Anderssarian (Christopher_Anderssarian) added a comment to T54062: wiki.blender.org links are redirecting to Blender Manual.

Thank you for your response,
while I appreciate the willingness to move the net render documentation (and was what prompted me to investigate the issue).
The reason I opened this task was to point out that the navigation on https://wiki.blender.org is not working.

Tue, Feb 13, 6:19 PM · Documentation
Aaron Carlisle (Blendify) assigned T54062: wiki.blender.org links are redirecting to Blender Manual to Brendon Murphy (meta-androcto).

This should really be moved to a new location since it is an addon, though @Brendon Murphy (meta-androcto) should do this

Tue, Feb 13, 4:39 PM · Documentation
Aaron Carlisle (Blendify) removed a project from T54062: wiki.blender.org links are redirecting to Blender Manual: Infrastructure: Websites.
Tue, Feb 13, 4:37 PM · Documentation
Aaron Carlisle (Blendify) moved T50464: Move content from wiki to manual from Backlog to Administrative on the Documentation board.
Tue, Feb 13, 4:33 PM · Documentation
Christopher Anderssarian (Christopher_Anderssarian) created T54062: wiki.blender.org links are redirecting to Blender Manual.
Tue, Feb 13, 2:40 AM · Documentation

Mon, Feb 5

Yevgeny Makarov (jenkm) added a commit to T51472: Remove gif images: rBM4014: gif file replacing.
Mon, Feb 5, 3:38 PM · Documentation

Mon, Jan 29

Ton Roosendaal (ton) added a comment to T51080: Blender Manual 404 page redesign .

Tobias: For all blender websites I've always appreciated to have a modern look and sophisticated design. The manual should comply to these standards as well.
There's a lot of creative freedom within that constraint, but not making it look like a personal hobby project. I find this ascii art page very uninviting. Please let's try to keep everyone on board here.

Mon, Jan 29, 6:45 PM · Documentation

Sun, Jan 28

Sybren A. Stüvel (sybren) added a comment to T53286: Upgrade information is missing in manual.

@Arihant Joshi (AJ) you can just claim the task ("Add Action...", "Assign / Claim").

Sun, Jan 28, 1:09 AM · Documentation

Fri, Jan 26

Bastien Montagne (mont29) removed a project from T53838: Link to "demo_file.zip" in chapter "Vehicle Controller Physics" of the user manual is broken.: BF Blender.
Fri, Jan 26, 3:28 PM · Game Physics, Documentation

Thu, Jan 25

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

@Aaron Carlisle (Blendify) now I'm curious something with template :)

Thu, Jan 25, 10:43 PM · Documentation
Pablo Vazquez (venomgfx) added a comment to T51080: Blender Manual 404 page redesign .

The current design with the ASCII art is just out of place when compared to any other blender website, including the docs site itself.

Thu, Jan 25, 1:30 PM · Documentation
Francesco Siddi (fsiddi) updated subscribers of T51080: Blender Manual 404 page redesign .

@Pablo Vazquez (venomgfx) and me have addressed some of the issue with the proposed solution. The original reason why this task was created is because of concerns about the overall design (both the layout and ASCII art).

Thu, Jan 25, 12:12 PM · Documentation

Jan 23 2018

Aaron Carlisle (Blendify) added a comment to T51080: Blender Manual 404 page redesign .

I have a solution to this that I can implement soon. Just having enough time right now is hard.

Jan 23 2018, 11:01 PM · Documentation
Tobias Heinke (TobiasH) added a comment to T51080: Blender Manual 404 page redesign .

It should match the theme as close as possible. The combination of e.g. color, shape, placement matters too.

Jan 23 2018, 9:46 PM · Documentation

Jan 22 2018

Friedemann Seebass (frisee) added a comment to T53838: Link to "demo_file.zip" in chapter "Vehicle Controller Physics" of the user manual is broken..

Please, do not delete the link! I do not think that the chapter "Vehicle Controller Physics" can be applied to an own project without the sample code. That's why I am highly interested in the file ...

Jan 22 2018, 4:54 PM · Game Physics, Documentation

Jan 21 2018

Arihant Joshi (AJ) added a comment to T53286: Upgrade information is missing in manual.

I would like to take this up.
Could this be assigned to me?

Jan 21 2018, 4:45 PM · Documentation
Yevgeny Makarov (jenkm) added a commit to T51472: Remove gif images: rBM3978: gif files replacing.
Jan 21 2018, 3:32 PM · Documentation
Yevgeny Makarov (jenkm) added a comment to T51472: Remove gif images.

Can anyone convert rendered image sequence to video and upload to youtube?
To replace this gif file:
physics_soft-body_collision_vertex-plane2.gif

Jan 21 2018, 11:38 AM · Documentation

Jan 20 2018

Yevgeny Makarov (jenkm) added a comment to T51080: Blender Manual 404 page redesign .

Do you need any help getting it committed?

Need someone to check JS script before.

Jan 20 2018, 9:13 AM · Documentation
Tobias Heinke (TobiasH) added a comment to T51080: Blender Manual 404 page redesign .

@Francesco Siddi (fsiddi) What? commit it directly >:(
Please don't commit commit it - thx.

Jan 20 2018, 2:44 AM · Documentation
Tobias Heinke (TobiasH) updated subscribers of T53838: Link to "demo_file.zip" in chapter "Vehicle Controller Physics" of the user manual is broken..

@Inês Almeida (brita_) was last one who edited the page in the old Wiki and probably created the file?
If it couldn't be found easily I would suggest to not dedicate to much time on it and to simply delete the link.

Jan 20 2018, 2:00 AM · Game Physics, Documentation
Francesco Siddi (fsiddi) added a comment to T51080: Blender Manual 404 page redesign .

This is an improved design. Thanks @Yevgeny Makarov (jenkm)!
Do you need any help getting it committed?

Jan 20 2018, 1:16 AM · Documentation
Philipp Oeser (lichtwerk) assigned T53838: Link to "demo_file.zip" in chapter "Vehicle Controller Physics" of the user manual is broken. to Tobias Heinke (TobiasH).

@Tobias Heinke (TobiasH) : I've looked around a bit, but couldnt find it on the net... You have an idea if this is around anywhere? Or who put this up on dropbox?
Maybe we should remove that link then?

Jan 20 2018, 12:00 AM · Game Physics, Documentation