ansys / ansys/pyensight

Conditionally include API section in documentation

Open
#258 4 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
10
Forks
2
Avg merge
8h 40m
Merged PRs (30d)
4

Description

🐞 **Problem**
There is a huge bottle neck when building the API documentation section in the docs. If possible, this section should be skipped by using the Jinja strategy we have followed in other repositories.

Contributor guide

Open the contributing guide

Research direction

Start by locating the documentation build configuration and the existing Jinja strategy used for conditional sections. Check how the API documentation section is assembled, then verify that it can be skipped during builds and that the resulting documentation remains correct when included.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.