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

Thu, Feb 14

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

So, I wrote the extension: a fragile patchwork of ways making the links absolute. Split between the template, the extension, the inline script.
The version is set to 'dev': that's bad for the old versions (solution: server redirect number to 'dev' , has to be updated every release, so no)
home links (/index) are not fixed, solutions: inline script loop over all 'A's; slow, thus bad for mobile
or maybe it can be done in the extension I'll try it *later.

Thu, Feb 14, 8:20 PM · Documentation

Wed, Feb 13

Yevgeny Makarov (jenkm) added a comment to T51172: Blender Documentation Roadmap.

Is there any chance to see the possibility of online editing? At least, with the most simplified features for small edits.

Wed, Feb 13, 9:58 AM · Documentation
Yevgeny Makarov (jenkm) added a comment to T56342: FIle downloads: re-evaluate .

It seems easier not to use the .blend files in the manual at all. Тoo many problems.

  • not one of the current files will not work/look well in 2.8
  • license (contributor may upload something is not suitable)
  • security (py-files or other executable code)
  • and so on

There may be links to external files in the see more section, for example files from developers in release logs.

Wed, Feb 13, 9:52 AM · Documentation

Thu, Feb 7

Julien DUROURE (julien) closed D4082: Documentation for glTF 2.0 exporter.

Doc is now commit into documentation svn

Thu, Feb 7, 10:54 AM · Documentation
Julien DUROURE (julien) accepted D4082: Documentation for glTF 2.0 exporter.
Thu, Feb 7, 10:53 AM · Documentation

Mon, Feb 4

blend-it (blend-it) added a comment to T42765: Italian translation (Blender UI and manual).

Grazie. Il manuale necessita di un bel po' di lavoro, se riesci a metterci mano sarebbe molto utile!

Mon, Feb 4, 4:35 PM · Documentation, Translations

Fri, Feb 1

Brecht Van Lommel (brecht) added a comment to T48096: New Wiki.

@Tuomo, note box removed.

Fri, Feb 1, 5:15 PM · Documentation, Infrastructure: Websites
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

Glad that you like the result! Cheers for ye olde wiki! :-)

Fri, Feb 1, 5:00 PM · Documentation, Infrastructure: Websites
Dan McGrath (dmcgrath) added a comment to T48096: New Wiki.

Let's consider this resolved then.

I have left a copy of the tarball in /root/en.blender.org.tar.bz2. Feel free to grab a copy (~5.5G). This contains the vhost docroot, the old txt only dumps, and the database dump.

I wouldn't know what to do with that file, I just imagined you had someplace to archive these kinds of things.

Fri, Feb 1, 3:44 PM · Documentation, Infrastructure: Websites
Brecht Van Lommel (brecht) updated the task description for T48096: New Wiki.
Fri, Feb 1, 3:40 PM · Documentation, Infrastructure: Websites
Brecht Van Lommel (brecht) closed T48096: New Wiki as Resolved.

Let's consider this resolved then.

Fri, Feb 1, 3:40 PM · Documentation, Infrastructure: Websites
Dan McGrath (dmcgrath) added a comment to T48096: New Wiki.

I forgot to mention that the old vhost docroot files have be entirely deleted, as well as the original database. The old docroot is a mere empty skeleton, needed to satisfy the Apache docroot path, as well as provide a means for Certbot (Lets Encrypt) to acquire its certificates. Once the snapshots rotate enough, the space from the old files will be reclaimed.

Fri, Feb 1, 3:29 PM · Documentation, Infrastructure: Websites
Dan McGrath (dmcgrath) added a comment to T48096: New Wiki.

Good to hear.

Fri, Feb 1, 3:25 PM · Documentation, Infrastructure: Websites
Brecht Van Lommel (brecht) added a comment to T48096: New Wiki.

Redirects are working well.

Fri, Feb 1, 2:36 PM · Documentation, Infrastructure: Websites
Brecht Van Lommel (brecht) updated the task description for T48096: New Wiki.
Fri, Feb 1, 2:33 PM · Documentation, Infrastructure: Websites
Brecht Van Lommel (brecht) triaged T61097: Wiki: port code architecture docs as Normal priority.
Fri, Feb 1, 2:30 PM · Infrastructure: Websites, Documentation
Brecht Van Lommel (brecht) updated the task description for T48096: New Wiki.
Fri, Feb 1, 2:28 PM · Documentation, Infrastructure: Websites
Brecht Van Lommel (brecht) updated the task description for T48096: New Wiki.
Fri, Feb 1, 2:27 PM · Documentation, Infrastructure: Websites
Dan McGrath (dmcgrath) added a comment to T48096: New Wiki.

Great! I guess that the 2 remaining points (Utilities and Delete the old read-only PHP wiki) can be wrapped up as well?
After that, I propose to close this task and move any other todo to separate topics, tagged as Documentation.

Fri, Feb 1, 11:50 AM · Documentation, Infrastructure: Websites
Francesco Siddi (fsiddi) added a comment to T48096: New Wiki.

Great! I guess that the 2 remaining points (Utilities and Delete the old read-only PHP wiki) can be wrapped up as well?
After that, I propose to close this task and move any other todo to separate topics, tagged as Documentation.

Fri, Feb 1, 11:21 AM · Documentation, Infrastructure: Websites
Francesco Siddi (fsiddi) updated the task description for T48096: New Wiki.
Fri, Feb 1, 11:16 AM · Documentation, Infrastructure: Websites
Dan McGrath (dmcgrath) added a comment to T48096: New Wiki.

Thanks @Tuomo Keskitalo (tkeskita)! And thanks @Brecht Van Lommel (brecht).
From a quick look the archived wiki seems to be running well in all its legacy glory.
Looking forward to the last steps that Dan will perform.

Fri, Feb 1, 1:25 AM · Documentation, Infrastructure: Websites

Thu, Jan 31

Francesco Siddi (fsiddi) added a comment to T48096: New Wiki.

Thanks @Tuomo Keskitalo (tkeskita)! And thanks @Brecht Van Lommel (brecht).
From a quick look the archived wiki seems to be running well in all its legacy glory.
Looking forward to the last steps that Dan will perform.

Thu, Jan 31, 11:54 PM · Documentation, Infrastructure: Websites
Dan McGrath (dmcgrath) added a comment to T48096: New Wiki.

Now it's just a matter of setting up a redirect from en.blender.org to archive.blender.org/wiki and taking the old wiki offline (I guess we keep a backup).

@Dan McGrath (dmcgrath), can you do that?

Thu, Jan 31, 1:41 AM · Documentation, Infrastructure: Websites

Wed, Jan 30

Brecht Van Lommel (brecht) added a comment to T48096: New Wiki.

It looks great, I found no problems. Thanks a lot for doing this.

Wed, Jan 30, 8:38 PM · Documentation, Infrastructure: Websites
Don McCurdy (donmccurdy) updated the diff for D4082: Documentation for glTF 2.0 exporter.

Include most recent documentation changes from GitHub repo.

Wed, Jan 30, 8:02 PM · Documentation
Don McCurdy (donmccurdy) added inline comments to D4082: Documentation for glTF 2.0 exporter.
Wed, Jan 30, 7:58 PM · Documentation
Don McCurdy (donmccurdy) updated the diff for D4082: Documentation for glTF 2.0 exporter.

Corrected a typo.

Wed, Jan 30, 7:57 PM · Documentation
Julien DUROURE (julien) added a comment to D4082: Documentation for glTF 2.0 exporter.

@Brecht Van Lommel (brecht): Thanks for the commit rights :)

Wed, Jan 30, 5:27 PM · Documentation
Don McCurdy (donmccurdy) added inline comments to D4082: Documentation for glTF 2.0 exporter.
Wed, Jan 30, 5:19 PM · Documentation
Brecht Van Lommel (brecht) added a comment to D4082: Documentation for glTF 2.0 exporter.

@Julien DUROURE (julien), you have commit rights to the documentation repository, so you can go ahead and commit this.

Wed, Jan 30, 5:09 PM · Documentation
Julien DUROURE (julien) added a comment to D4082: Documentation for glTF 2.0 exporter.

@Martin Capitanio (capnm) : Documentation is how addon should work.
If you detect a bug, please open an issue upstream (https://github.com/KhronosGroup/glTF-Blender-IO), but comments into documentation is maybe not the best place to keep trace of it.

Wed, Jan 30, 4:59 PM · Documentation
Martin Capitanio (capnm) added inline comments to D4082: Documentation for glTF 2.0 exporter.
Wed, Jan 30, 6:08 AM · Documentation

Tue, Jan 29

Don McCurdy (donmccurdy) added a comment to D4082: Documentation for glTF 2.0 exporter.

Quick ping on this change – I'd like to point new users to this documentation when possible. Thanks!

Tue, Jan 29, 4:55 AM · Documentation

Mon, Jan 28

Jacques Lucke (JacquesLucke) closed D4270: Trivial Language Correction.

https://developer.blender.org/rBM4563

Mon, Jan 28, 4:24 PM · Documentation
Brecht Van Lommel (brecht) added a comment to D4270: Trivial Language Correction.

There is no way to commit as a different author in svn. Instead you can write like "Contributed by Cecil Churms." in the commit log.

Mon, Jan 28, 4:10 PM · Documentation
Jacques Lucke (JacquesLucke) added a comment to D4270: Trivial Language Correction.

@Brecht Van Lommel (brecht), I managed to download the repo, applied the patch and build it. How should I commit it? Can I commit it as someone else?

Mon, Jan 28, 4:08 PM · Documentation
Jacques Lucke (JacquesLucke) accepted D4270: Trivial Language Correction.
Mon, Jan 28, 4:01 PM · Documentation
Brecht Van Lommel (brecht) added a member for Documentation: Sebastian Parborg (zeddb).
Mon, Jan 28, 3:40 PM
Brecht Van Lommel (brecht) added a reviewer for D4270: Trivial Language Correction: Jacques Lucke (JacquesLucke).

For bigger changes it's best to involve @Aaron Carlisle (Blendify) and @Tobias Heinke (TobiasH), but other than that it's absolutely fine to review and commit for the manual.

Mon, Jan 28, 3:36 PM · Documentation
Brecht Van Lommel (brecht) removed a reviewer for D4270: Trivial Language Correction: Documentation.
Mon, Jan 28, 3:33 PM · Documentation
Jacques Lucke (JacquesLucke) updated subscribers of D4270: Trivial Language Correction.

@Brecht Van Lommel (brecht), may I accept and merge changes to the manual? (I'm not even sure if I have commit rights)

Mon, Jan 28, 2:49 PM · Documentation
Cecil Churms (CecilChurms) added a comment to D4270: Trivial Language Correction.

This is a precursor to more documentation improvements, especially along language usage lines (spelling, grammar).

Mon, Jan 28, 2:47 PM · Documentation
Cecil Churms (CecilChurms) created D4270: Trivial Language Correction.
Mon, Jan 28, 2:44 PM · Documentation
Francesco Siddi (fsiddi) closed T60943: Wiki: Bad word wrapping inside lists as Resolved.

Wrapping has been tweaked for page width over 992px.
ol, p, ul and center were set to max-width: 60%, now they will follow max-width: 80%.

Mon, Jan 28, 12:17 PM · Documentation
Sergey Sharybin (sergey) renamed T60943: Wiki: Bad word wrapping inside lists from Bad word wrapping inside lists to Wiki: Bad word wrapping inside lists.
Mon, Jan 28, 11:26 AM · Documentation
Sergey Sharybin (sergey) assigned T60943: Wiki: Bad word wrapping inside lists to Francesco Siddi (fsiddi).
Mon, Jan 28, 11:25 AM · Documentation
Sergey Sharybin (sergey) created T60943: Wiki: Bad word wrapping inside lists.
Mon, Jan 28, 11:25 AM · Documentation

Sun, Jan 27

Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

OK, I'm glad to inform you that the static old wiki baking is finished. The current version is uploaded temporarily to http://tkeskita.kapsi.fi/temp/en.blender.org and download package is available in http://tkeskita.kapsi.fi/temp

Sun, Jan 27, 5:12 PM · Documentation, Infrastructure: Websites

Sat, Jan 26

Brecht Van Lommel (brecht) closed T57037: Math node: new math modes as Resolved.

Already in the manual now.

Sat, Jan 26, 12:14 AM · Documentation