Campbell Barton
5d92fd8a90
Correct last commit
2020-10-16 20:51:58 +11:00
Campbell Barton
b002fdc4bf
PyDoc: update to account for new context member
2020-10-16 20:29:55 +11:00
Aaron Carlisle
4fa4245464
PyDocs: GPU Module: Examples: convert all gl_FragColor variables to FragColor
...
Based on D6425 by @robbott
Differential Revision: https://developer.blender.org/D6425
2020-10-14 11:18:36 -04:00
Aaron Carlisle
cf778a9e42
Pydoc: BGL: update links
2020-10-11 20:14:16 -04:00
Aaron Carlisle
df3d124e91
Pydoc: Fix bpy.utils submodule showing in main toctree
2020-10-11 18:38:55 -04:00
Aaron Carlisle
72335d5e89
Pydoc: Move builtin GPU shader information to code
...
This fixes a compile warning for sphinx.
This commit includes some reformating of the information.
2020-10-11 18:21:28 -04:00
Aaron Carlisle
e8a2931299
Pydoc: Cleanup: Rename function
...
The new name makes more sense as the file is called index and we are not
writing the contents of all rst files
2020-10-11 17:02:41 -04:00
Aaron Carlisle
a38c2dcfe6
Pydoc: Add index and genindex to main index
2020-10-11 16:54:52 -04:00
Aaron Carlisle
c95ab2c6f0
Pydoc: Remove old note about new module in 2.65
2020-10-11 16:46:21 -04:00
Aaron Carlisle
fbcb26fb33
Pydoc: Add submodule heading to submodule lists
2020-10-11 16:09:42 -04:00
Aaron Carlisle
f735491b9f
PyDoc: Set max width to 1000px
...
While not full width this gives a nice trade off between improved screen
use space and readibility.
The old value was 80 so this gives 25% more screen space.
See T73223
2020-10-08 21:37:28 -04:00
Campbell Barton
decb3b10aa
Cleanup: operator execution types didn't read well on one line
2020-10-09 12:14:22 +11:00
Campbell Barton
05710171cb
PyDoc: resolve duplicate module warnings
...
Remove submodule listings from the module docstring,
as this information already exists in the generator.
2020-10-09 12:11:00 +11:00
Aaron Carlisle
fb20efae59
PyDoc: fix most of the sphinx-build warnings
...
Use `.. currentmodule::` instead of `.. module::` for `bpy.types` and
`bpy.ops`. This change fixes most of the errors.
Ref D9139
2020-10-08 16:27:42 +11:00
Campbell Barton
0b4aeffda9
PyDoc: support building without sphinx_rtd_theme
...
This is no longer bundled with sphinx, support building without it.
2020-10-08 12:32:50 +11:00
Campbell Barton
05d637280c
Fix recent update to sphinx_doc_gen.sh
...
2f1a0f6f0e
copied Makefile syntax into a
shell script. Use sphinx-builds 'auto' command to set the number of
jobs to run.
2020-10-08 11:08:36 +11:00
Aaron Carlisle
c4a281e801
PyDoc: Use explicit class names to refence class
...
This fixes the link and makes it more clear which class the note is
talking about
2020-10-07 17:25:19 -04:00
Aaron Carlisle
d88da4db67
PyDoc: Render in text class name using class link syntax
2020-10-07 17:00:57 -04:00
Aaron Carlisle
021b94f27c
PyDoc: Fix sphinx warnign from missing newline
2020-10-07 15:51:29 -04:00
Aaron Carlisle
2f1a0f6f0e
PyDoc: Multithread sphinx-build
...
Compile times went from over 5min to under 2 on my laptop.
2020-10-07 10:25:46 -04:00
Aaron Carlisle
e748abda92
PyDoc: Remove workaround for slow sphinx builds
...
Tesing with newer versions of sphinx to directory `sphinx-build` is
executed has no affect on the build time. Testing even gave a 2-3% speed
boost.
2020-10-07 10:25:46 -04:00
Aaron Carlisle
7951312d4b
API Doc Gen: Do not ignore objects file
...
This is used by the Blender manual or other sphinx website that would
like to link to Blender's API documentation.
2020-10-05 16:26:40 -04:00
Campbell Barton
41d2d6da0c
Cleanup: pep8 (indentation, spacing, long lines)
2020-10-02 11:59:16 +10:00
Campbell Barton
bab9de2a52
Cleanup: pep8, blank lines
2020-10-02 11:59:16 +10:00
Campbell Barton
28ebe827e6
Cleanup: trailing space
2020-10-02 11:59:16 +10:00
Aaron Carlisle
b150071ece
Cleanup: Python API Docs: Text formating
2020-09-28 20:11:06 -04:00
Aaron Carlisle
4d7b664e1a
API Docs: Minor text improvements
2020-09-28 20:11:06 -04:00
Max Schlecht
aead4b3cab
API Docs: Fix xref urls
...
Fully revert D7913 "Fix T77276: Generating Python API docs raises many warnings"
{D7913} broke xrefs/links to other types and permalinks in the docs. This makes the python api docs for 2.90 and 2.91 completely unusable.
It got partially reverted in commit e893430a63
. That didn't fix those two issues though, so it should be fully reverted.
As you can see here, i'm not able to click `bpy_struct.id_data`, because no <a> tag got generated in the html.
{F8889934}
Here you can see a working, but wrong permalink, generated by clicking the little chain. (It should be `bpy.types.MeshVertices`, not `bpy.types.MeshVertices.MeshVertices`)
{F8889938}
Reviewed By: Blendify
Differential Revision: https://developer.blender.org/D8913
2020-09-24 23:14:15 -04:00
Bastien Montagne
211d213160
API doc: Gotcha's: Add section about abusing RNA properties callbacks.
...
Especially with new undo/redo it is even less recommended to perform
complex operations in those callbacks, they should remain as fast and
localized as possible.
Also updated the section about undo/redo a bit.
2020-09-14 11:02:52 +02:00
Aaron Carlisle
950d857505
Merge branch 'blender-v2.90-release'
2020-08-24 10:40:12 -04:00
Aaron Carlisle
9498eb2692
API Docs: Update Changelog from 2.83
2020-08-24 10:38:17 -04:00
Brecht Van Lommel
6238eabcd4
Merge branch 'blender-v2.90-release'
2020-08-12 18:50:40 +02:00
Brecht Van Lommel
54c2c14921
CMake: clarify that the modules are licensed BSD 3-Clause
...
Many of these are derived from similar modules in the CMake project, which
have this license.
Fixes T79715
2020-08-12 18:49:16 +02:00
Philipp Oeser
42f4233871
Merge branch 'blender-v2.90-release'
2020-08-05 14:10:08 +02:00
Philipp Oeser
229fe01a15
PyDoc: use glClearColor before glClear in gpu docs
...
ref T79491
Maniphest Tasks: T79491
Differential Revision: https://developer.blender.org/D8471
2020-08-05 14:09:00 +02:00
Sybren A. Stüvel
e8869d9c71
Merge remote-tracking branch 'origin/blender-v2.90-release'
2020-07-27 19:02:44 +02:00
Aaron Carlisle
e893430a63
Partly revert "Fix T77276: Generating Python API docs raises many warnings"
...
This commit reverts the "noindex" part of the original commit.
using noindex made it imposible to link to a specific property.
The original warnings do not pose an issue so until a proper solution is
found I am reverting this commit.
This reverts commit 953c232db3
2020-07-27 13:01:28 -04:00
Nathan Letwory
5a1a4f4dd2
master is now 2.91.0 alpha.
2020-07-22 16:48:29 +03:00
Campbell Barton
a197b81090
Docs: include 'bl_math' module
2020-07-22 14:36:30 +10:00
Campbell Barton
20446f07f6
Docs: reference bl_rna_get_subclass_py instead of bl_rna_get_subclass
...
bl_rna_get_subclass only works for Nodes at the moment.
2020-07-06 23:07:18 +10:00
Aaron Carlisle
b7b57e7155
PyDoc: Update Python Package Requirements
2020-06-26 13:24:53 -04:00
Aaron Carlisle
b0449cac66
API Docs: Small edits to recent commit
...
- Revert string formatting change
- Add missing text edit
2020-06-23 17:10:07 -04:00
Campbell Barton
bab2b02507
Cleanup: style, raw multi-line string sphinx updater
2020-06-23 23:32:47 +10:00
Campbell Barton
6d639a606c
Docs: quiet deprecation warning, add missing context members
2020-06-23 23:32:36 +10:00
Tobias Heinke
23f8ab4250
API docs: intro overhaul
...
- Update terminology, spelling, formatting.
- Rename screen to workspace.
- Update for 2.8 UI changes.
2020-06-23 23:13:10 +10:00
Campbell Barton
502e6bd839
Fix doc generation for enum & attr's with multi-line descriptions
2020-06-18 16:26:16 +10:00
Aaron Carlisle
953c232db3
Fix T77276: Generating Python API docs raises many warnings
2020-06-04 22:31:54 +10:00
Aaron Carlisle
2e52b3206c
PyDoc: Fix warnings from out of bounds include statement
2020-06-02 18:21:42 -04:00
Bastien Montagne
8d670546f9
Merge branch 'blender-v2.83-release'
2020-06-01 12:12:57 +02:00
Bastien Montagne
31cf87a29e
Fix py api doc gen script after recent versionning changes.
2020-06-01 12:10:56 +02:00