readthedocs / readthedocs/sphinx-autoapi

`duplicate object description` when redefing variable with `if` block

Open
#335 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Especially it is raised when trying generate docs for conf.py in RTD, because RTD modify conf.py.

# conf.py while RTD generating docs
...
html_static_path = ["_static"]
...

###########################################################################
#          auto-created readthedocs.org specific configuration            #
###########################################################################
...
# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')
...

Sample build from my prod.

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 reproducing the duplicate object description error while generating documentation for the provided conf.py example in Read the Docs. Trace how the redefined variable inside the if block is processed; done means the documentation build completes without this error.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.