ansys / ansys/pyaedt-examples

FEATURE: do not need thumbnail and leverage runtime generated image

Open
#8 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
44
Forks
13
Avg merge
5d 12h
Merged PRs (30d)
6

Description

Currently, we propose our examples with a thumbnail and it is leveraged when generating the documentation.
This adds the constraint that each example is associated to a thumbnail stored in the repo.

It would be nice to get rid of this constraint and allow the documentation build to retrieve the first/last/somethingelse generated image as thumbnail. On top of easing the process of adding new examples it would lessen the weight of the repo !

Contributor guide

Open the contributing guide

Research direction

Start by tracing the documentation build and how it currently uses repository thumbnails for examples. Define completion as allowing the build to select a generated image for each example while removing the requirement to store a separate thumbnail, then verify the documentation still builds correctly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.