ansys / ansys/pymechanical

Hide unpublished APIs in API reference

Open
#1,470 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
83
Forks
37
Avg merge
1d 3m
Merged PRs (30d)
26

Description

ref : https://mechanical.docs.pyansys.com/version/0.10/api/index.html
currently we are showing all APIs, https://mechanical.docs.pyansys.com/version/stable/api/ansys/mechanical/core/index.html

Contributor guide

Open the contributing guide

Research direction

Compare the version 0.10 and stable API reference pages linked in the issue, then trace the documentation-generation entry point that produces them. Done means unpublished APIs no longer appear in the reference while published APIs remain available; the payload does not name a file or test to run.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.