Commit Graph

11 Commits

Author SHA1 Message Date
Campbell Barton
994d75b6ae spelling cleanup: spelling corrections from user zeffii on IRC. 2012-08-19 15:28:24 +00:00
Thomas Dinges
4fc078001d Documentation:
* Some UI docs for the Best Practise guide. Still WIP.
2012-07-29 01:38:31 +00:00
Howard Trickey
ef1d3a3993 Fixed a couple of typos in the Python API docs 2012-03-23 14:29:59 +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
Campbell Barton
2d2d0da51b remove blender 2.5 references in docs 2012-01-12 15:16:08 +00:00
Campbell Barton
cce9c43295 correct api doc examples and a typo 2012-01-05 05:43:35 +00:00
Campbell Barton
9a0bf1ffa4 Correct use of your vs you're in py api docs 2012-01-04 03:22:37 +00:00
Campbell Barton
9aaa67cc4c corrections for docs 2011-11-28 17:19:25 +00:00
Campbell Barton
cc1ed7cbc5 fix/update for credits script and bad formatting in sphinx docs. 2011-10-17 13:54:47 +00:00
Campbell Barton
2dc6ca49b3 py docs:
added python doc section on script performance and a note on relative file paths in the gotcha's page.
also added script for spell checking py comments.
2011-10-17 10:43:55 +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