API: images, use external image with sphinx 1.6 #51473

New Issue

Aaron Carlisle · 2017-05-11T18:45:56+02:00

Aaron Carlisle commented

2017-05-11 18:45:56 +02:00

Once sphinx 1.6 is out we should consider using remote images. The downside is they will not be available if the user downloads the zip and has not internet connection. We can then host the images in rBM

Aaron Carlisle commented

2017-05-11 18:45:56 +02:00

Changed status to: 'Open'

Aaron Carlisle commented

2017-05-11 18:45:56 +02:00

Added subscriber: @Blendify

Aaron Carlisle commented

2017-05-11 18:46:34 +02:00

Added subscribers: @mont29, @ideasman42

Campbell Barton commented

2017-06-14 20:52:31 +02:00

What are the benefits / whats this solve?
What are the down-sides?
What will the figure/image URL look like before/after?
How would this impact building PDF?

I'd assume remote images adds some complications to managing images (adding / removing / checking what images from some spesific revision looks like).

* What are the benefits / whats this solve? * What are the down-sides? * What will the figure/image URL look like before/after? * How would this impact building PDF? I'd assume remote images adds some complications to managing images (adding / removing / checking what images from some spesific revision looks like).

Aaron Carlisle commented

2017-06-14 21:07:48 +02:00

Currently, the only images in use are on this page: https://docs.blender.org/api/current/info_tutorial_addon.html

Another solution would to simply remove all images from the API docs.

The benefits: gives everyone easy access to the images apposed to right now we get compiling warnings about missing images unless we download them from a previously build of the docs

The downsides: The downside is they will not be available if the user downloads the zip and has no internet connection. Another issue would be that we need to keep images URL the same after that build is up (no renaming images). Images must also live in svn forever.

What will the figure/image URL look like before/after: Before: https:*docs.blender.org/api/current/_images/spacebar.png After: https:*svn.blender.org/svnroot/bf-blender/2.78/images/spacebar.png

How would this impact building PDF: unknown but should work just the same. If not we report the bug to sphinx.

Currently, the only images in use are on this page: https://docs.blender.org/api/current/info_tutorial_addon.html Another solution would to simply remove all images from the API docs. **The benefits:** gives everyone easy access to the images apposed to right now we get compiling warnings about missing images unless we download them from a previously build of the docs **The downsides:** The downside is they will not be available if the user downloads the zip and has no internet connection. Another issue would be that we need to keep images URL the same after that build is up (no renaming images). Images must also live in svn forever. **What will the figure/image URL look like before/after:** Before: https:*docs.blender.org/api/current/_images/spacebar.png After: https:*svn.blender.org/svnroot/bf-blender/2.78/images/spacebar.png **How would this impact building PDF:** unknown but *should* work just the same. If not we report the bug to sphinx.

Campbell Barton commented

2017-06-14 21:09:55 +02:00

Tsk, my bad was thinking this was related to the manual. +1.

Since we have so few images or so, and they aren't really essential for the API docs so prefer keeping them remove instead of putting images in Blender's git repo.

Tsk, my bad was thinking this was related to the manual. +1. Since we have so few images or so, and they aren't really essential for the API docs so prefer keeping them remove instead of putting images in Blender's git repo.

Aaron Carlisle commented

2017-06-16 05:17:28 +02:00

Changed status from 'Open' to: 'Archived'

Aaron Carlisle closed this issue

2017-06-16 05:17:28 +02:00

Aaron Carlisle self-assigned this 2017-06-16 05:17:28 +02:00

Aaron Carlisle commented

2017-06-16 05:17:28 +02:00

We decided to host this doc on the manual instead.

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

API: images, use external image with sphinx 1.6 #51473