sphinx-doc / sphinx-doc/sphinx

Add examples and/or usage description of `autosummary_filename_map`

Open
#11,238 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

extensions:autosummary
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.

My problem is essentially described by this comment that I left in the repo of sphinx.automodapi
https://github.com/astropy/sphinx-automodapi/issues/73#issuecomment-1466259565

I am not sure if the issue is fixable upstream (aka here) or there, so I chose to bother everyone :)

I kind of understand what the autosummary_filename_map configuration option does, but it is not clear to me
if it is supposed to fix my problem and how to properly use it.

Describe the solution you'd like

I'd ask at least for some examples in the documentation (perhaps even inspired by my use case and/or the sciki-learn one.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the documentation for the autosummary_filename_map configuration option and review the linked sphinx-automodapi and scikit-learn examples. Add clear usage examples or a description that explains when and how the option addresses the reported use case, then verify the documentation builds successfully.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.