sphinx-doc / sphinx-doc/sphinx

Show which file is being processed

Open
#11,259 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

extensions:autosummary type:enhancement
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.
When I run my make command (in my case make confluence it processes many files (I assume part of autosummary, but also rst files). I get a lot of errors, but I can't tell which files the correspond to. These are probably python import-level errors (so maybe this request is more autosummary specific); the rst sometimes specifies the file in the error, but not always. For example, we are trying to migrate many python files and refactor our code, using autosummary. I get many pythyon-errors/warnings from the autosummary but also like "WARNING: unable to build link to document due to missing title (in index): genindex", which is easier to track down, but it still doesn't say the file it's processing.

Describe the solution you'd like
I would just like a mention in the output of what file it is processing so I know what file to look at to fix the errors. Otherwise I'm having to look through each files trying to find out where the errors are coming from.

Describe alternatives you've considered
I don't see any flags or anything that would allow for this ability. My apologies if I don't understand the proper workflow. Thank you for the great package!

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 by reproducing the issue with the make confluence command and inspect how autosummary and rst files report warnings. Done means processing errors and warnings identify the file being processed, including messages such as missing-title warnings.

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.