1berry/blender
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
36,989 Commits 31 Branches 238 Tags
Commit Graph

63 Commits

Author SHA1 Message Date
Luca Bonavita
e4253fa2b8 == Python API docs == 
- Enhanced the -T option:

  - we can now choose among custom themes (now 'blender-org' and later 'naiad')
    and Sphinx internal themes (use -h option to see which ones)

  - choosing a custom theme will copy the theme dir to the output dir

- Added two new command line options:

  -N: Add the theme name to the html dir name
      For example, if we choose the theme 'haiku'
      with using -N will create html files in sphinx-out_haiku/
      Useful to test separate themes without overwriting the smae folder each time
      
  -B: Builds the html docs running sphinx-build
      This is useful to avoid runing sphinx with a separate shell command

- Fixed the URL in undocumented_message()
 2012-03-08 18:36:23 +00:00
Campbell Barton
ee84084f99 style cleanup: pep8 + picky edits 2012-03-08 05:36:05 +00:00
Luca Bonavita
4aadffa80e == Python API docs == 
(sphinx_doc_gen.py)

- file reorganization to use more functions (easier to read)

- adapting to work after a recent commit that made some of the members of bpy.app.*
  output bytes instead of strings (see [#30154])

- a couple of new command line optionsto avoid editing the script:
    -T: let you choose the sphinx theme: the theme dir get copied in the destination dir
    -b: choose if we want the bpy module page or not

    Current command line arguments optional arguments:
      -h, --help            show this help message and exit
      -o OUTPUT_DIR, --output OUTPUT_DIR
                            Path of the API docs (default=<script dir>)
      -T SPHINX_THEME, --sphinxtheme SPHINX_THEME
                            Sphinx theme (default='default')
      -f, --fullrebuild     Rewrite all rst files in sphinx-in/ (default=False)
      -t, --testdump        Dumps a small part of the API (default=False)
      -b, --bpy             Write the rst file of the bpy module (default=False)

(rst/info_best_practice.rst)

- fixed a typo
 2012-03-07 17:36:38 +00:00
Luca Bonavita
0fe519f14a == Python API docs == 
Adding two new command line options (-f = full rebuild, -t = testing) so that we don't have to edit the file each time
 2012-03-05 14:12:38 +00:00
Luca Bonavita
8856a9cbcd == Python API docs == 
- Works in macOSX now (hackish)
  (TODO: not check for OSX explicitly but handle exception if it fails)

- We can now generate rst files outside out of the source (was annoying)
  - Moved some vars at module level
  - Managing the command line args with argparse.
    Example usage:
    ./cmake/bin/blender -b -P ./blender/doc/python_api/sphinx_doc_gen.py -- -o ./python_api
 2012-03-02 14:39:18 +00:00
Campbell Barton
edb04d1461 bmesh docs now written in sphinx doc generator. 
* http://www.blender.org/documentation/blender_python_api_2_62_0/bmesh.types.html
* http://www.blender.org/documentation/blender_python_api_2_62_0/bmesh.utils.html
 2012-02-24 09:53:29 +00:00
Campbell Barton
387ce06732 Disable PDF doc since its giving errors with latex indentation. 
upload the zipped version of HTML docs instead.
 2012-02-10 15:00:55 +00:00
Campbell Barton
4c93e0ada3 include mathutils.noise in sphinx docs 2011-12-04 06:55:32 +00:00
Campbell Barton
1c6dc61d17 blacklist language property for sphinx docs, encoding was messing up PDF generation. 2011-11-24 22:24:07 +00:00
Campbell Barton
1cfbde0eb4 pass encoding to uses of decode() incase the default isnt utf-8. ignore decode errors in some cases. 
This should fix an error with generated qtcreator projects.

also replace decoded bytes for unicode escape sequences in the VIEW3D_MT_edit_text_chars menu.
 2011-11-17 04:05:54 +00:00
Campbell Barton
747f06d3d2 set cycles scripts as pep8 & make some minor changes. 
also update sphinx doc generator.
 2011-11-15 02:58:01 +00:00
Campbell Barton
057bf2a02b misc doc edits 
- remove recently added sphinx reference workaround.
- tested doxygen, correct some warnings, set tab width and added pymathutils group.
- added convenience target 'make doc_doxy'
 2011-11-05 01:48:10 +00:00
Campbell Barton
209ceb6969 correct some warnings, also sensor_x was being paassed to object_camera_matrix(...) for x and y args, looks like an accident 2011-11-04 15:21:34 +00:00
Campbell Barton
87cd81b162 - added docs and examples for bpy.app.handlers 
- correct error in own last commit for BKE_screen_find_big_area()
 2011-11-04 04:27:46 +00:00
Campbell Barton
f8d0c8b11e patch [#29049] Minor phrasing and grammar patch 2011-10-28 01:10:46 +00:00
Campbell Barton
617d3cb852 pass -noaudio when running blender for various utilities - doc-gen and tests. 2011-10-19 21:55:27 +00:00
Campbell Barton
c40b976ea8 py docs - gpu module wasn't included in docs. 
also added convenience target to build sphinx api docs:
 make doc_py
 2011-10-13 06:59:09 +00:00
Campbell Barton
e3be5aacf8 fix [#28873] Blenders Python API Sphinx Build Script give exceptions 2011-10-11 23:27:01 +00:00
Campbell Barton
081543fee8 fix for error generating docs, write all files as utf-8 2011-09-29 12:11:58 +00:00
Campbell Barton
8f5112f191 pep8 update & some minor cmake edits. 2011-09-20 18:29:19 +00:00
Campbell Barton
00de0cd6a7 fix for warnings after texface commit, also comment blender sphinx theme for api reference until we get an update for 'Naiad' 2011-09-20 01:35:39 +00:00
Campbell Barton
862aababb3 - remove deprecated pose channel members 
- change short -> char for flags that support it.
- add pose 'temp' pointer to use for outliner drawing (was using 'prev' and restoring which seems dodjy)
 2011-09-16 02:42:50 +00:00
Campbell Barton
e2818f1b92 - include enum names and descriptions in sphinx generated documentation 
- add descriptions for operator bl_options
 2011-09-15 16:15:24 +00:00
Campbell Barton
4eb9b9e4f1 bpy api - add new page for best-practice (so Thomas has something to point to when kicking devs for writing shoddy UI layouts) 2011-09-08 23:59:47 +00:00
Campbell Barton
290ad64a22 finished tips and tricks section of blender/python api docs, now included in generated docs. 2011-09-08 01:26:23 +00:00
Campbell Barton
67712c10c4 fix for doc building after pepper merge, also WIP tips/tricks. 2011-09-06 00:12:34 +00:00
Campbell Barton
b20c9b0ba3 minor edits, pep8 - also correct float -> double promotion for blf. 2011-08-30 10:49:58 +00:00
Campbell Barton
e9ca846018 document some of the pitfalls in the blender python api (taken from frequent mails and bug reports) 2011-08-26 04:00:55 +00:00
Campbell Barton
50a9454e0f move wiki api intro and overview docs into the api reference docs. 
Updated docs since some parts still were from beta still.
 2011-08-25 04:25:33 +00:00
Campbell Barton
75a63981cd add warning about misuse of ID.user_clear() since it can crash blender. 2011-08-23 11:28:18 +00:00
Campbell Barton
f4293067c1 py api: sphinx doc corrections, pep8 cleanup and style edits, also added __all__ to some modules which were missing it. 2011-07-31 03:15:37 +00:00
Campbell Barton
6aae2698ac patch [#27885] bge.constraints documentation 
by Solano Felicio (solano)
 2011-07-08 02:59:25 +00:00
Campbell Barton
af27622a87 some corrections to bge.texture docs 2011-07-07 19:23:51 +00:00
Campbell Barton
01550f880e add 'bgl' OpenGL doc to sphinx 2011-07-01 11:16:42 +00:00
Campbell Barton
69ff819a2e print the help message if running from python directly. 2011-06-27 04:50:08 +00:00
Campbell Barton
a9dd90be78 move load_image into image_utils and add some docstrings to bpy_extras module. 2011-05-28 09:34:45 +00:00
Campbell Barton
ecf2d1ff4e - generate sphinx docs for bpy_extras module 
- add in support to doc generator for automatically generating docs for submodules.
 2011-05-28 07:47:58 +00:00
Campbell Barton
05a78baa87 sphinx api docs: fix for addons linking to the wrong operator SVN url's. 
also change from blender from 'release' back to beta so new docs don't overwrite the 2.57b release docs.
 2011-05-05 14:45:24 +00:00
Campbell Barton
9ba543a522 minor improvements to sphinx doc main page 2011-04-13 14:43:11 +00:00
Campbell Barton
2ed8b5f679 reference the release PDF correctly 2011-04-12 16:56:15 +00:00
Campbell Barton
ba03e5023e less alarming warnings about the python api not being stable in online docs and remove from interactive console. 2011-04-12 12:09:38 +00:00
Campbell Barton
24b012c978 Sphinx RNA API changelog generator. 
- lists added and removed functions and properties.
- lists renamed properties (does fuzzy comparison using min/max, description, type)
- lists functions with arguments changed.

Committed change log from 2.56 -> 2.57:
  http://www.blender.org/documentation/250PythonDoc/change_log.html
 2011-04-07 07:53:28 +00:00
Campbell Barton
d4a9bc1c21 while looking into adding back brush tool keys found mixed texture/image paint rna vars, using 'image paint' internally. 2011-04-01 04:22:30 +00:00
Campbell Barton
2900557568 examples for keyframing nested paths. based on report from user der_On's report [#25746] 2011-03-31 12:45:54 +00:00
Campbell Barton
50a06eccff pep8 cleanup 2011-03-27 05:23:14 +00:00
Campbell Barton
1b80538fea fix [#25688] undocumted functions in pyapi 
expose collection function docs.
 2011-03-22 04:28:51 +00:00
Campbell Barton
2d1ef275f2 bpy.types.libraries.load sphinx doc & examples (doc system needed some updates). 
http://www.blender.org/documentation/blender_python_api_2_56_3/bpy.types.BlendDataLibraries.html#bpy.types.BlendDataLibraries.load
 2011-03-14 10:31:50 +00:00
Campbell Barton
bc15e0e295 add NDEBUG to scons release flags + some pep8 cleanup for examples. 2011-02-25 16:19:50 +00:00
Campbell Barton
dd8383e469 make doc generation close files (py3.2 complains about this), 
minor formatting changes for C docstrings.
 2011-02-22 05:23:20 +00:00
Campbell Barton
251d27110b examples for bpy.props 2011-02-18 14:27:18 +00:00