astropy / astropy/sphinx-automodapi

How to disable or custom "module name prefix" in generated documents?

Open
#107 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

For example,
```rst
.. function numpy.clip ::
```
And how can I custom the prefix to be `np.clip`? Or simply `clip`?
See https://taichi-glsl.readthedocs.io/en/latest/api/taichi_glsl.glsl.clamp.html, my users are expected to `import taichi_glsl as ts` and play with it like `ts.clamp` instead of `taichi_glsl.glsl.clamp`.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the reStructuredText directive example in the issue and inspect the generated API page linked for the current module-name prefix behavior. Determine where sphinx-automodapi exposes or builds that prefix, then verify that it can be disabled or changed to aliases such as `np.clip` or `clip`.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.