readthedocs / readthedocs/sphinx-autoapi

Warning prompts the position of .rst file rather than .py file

Open
#230 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Language: Python
Dominant language
Python
Stars
494
Forks
147
Avg merge
9m
Merged PRs (30d)
1

Description

Is there anyway for me to overwrite the map() function in mappers/python/mapper.py?

Contributor guide

No contributing guide indexed for this repository

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 reading mappers/python/mapper.py, especially the map() function, and reproduce the warning described in the issue to determine why it points to the .rst file. Check how mapper functions are selected or overridden; done means establishing a supported way to replace map() or documenting that it is not possible, with the warning pointing to the intended source file.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.