Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

autosummary: generated stub files are not re-written #247

Closed
shimizukawa opened this issue Jan 2, 2015 · 3 comments
Closed

autosummary: generated stub files are not re-written #247

shimizukawa opened this issue Jan 2, 2015 · 3 comments
Labels
extensions:autosummary type:enhancement enhance or introduce a new feature
Milestone
3.0.0

Comments

@shimizukawa
Copy link
Member

If the top-level autosummary directive is changed from one sphinx run to the other (e.g. a new option added or the template was changed) the generated stub files in the directory given with the :toctree: option are not automatically updated.

The are onyl re-created if the stub files direcory is deleted manually from the file explorer.
@shimizukawa shimizukawa added this to the 1.x milestone Jan 2, 2015
@shimizukawa shimizukawa added type:enhancement enhance or introduce a new feature extensions labels Jan 2, 2015
@shimizukawa
Copy link
Member Author

From pv on 2009-08-30 13:10:45+00:00

This was intended to be a feature allowing customizing the stub files manually when needed. At the moment, I'm undecide which is better.

@Michael-E-Rose
Copy link

If I understand this correctly I really like to see this feature being implemented. Whenever new attributes or methods are being added to classes or modules, I am forced to do so much manually which can really be automated.

@tk0miya tk0miya modified the milestones: 1.x, 2.0.0 Oct 6, 2018
@tk0miya tk0miya modified the milestones: 2.0.0, 2.1.0 Feb 13, 2019
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jun 1, 2019
@tk0miya
Fix sphinx-doc#247: autosummary: Add autosummary_generate_option to o…
5b50c8a 
…verwrite old stub file
@tk0miya tk0miya mentioned this issue Jun 1, 2019
Merged
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jun 1, 2019
@tk0miya
Fix sphinx-doc#247: autosummary: Add autosummary_generate_option to o…
29f5d6f 
…verwrite old stub file
@tk0miya tk0miya modified the milestones: 2.1.0, 2.2.0 Jun 2, 2019
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jun 2, 2019
@tk0miya
Fix sphinx-doc#247: autosummary: Add autosummary_generate_option to o…
860ada4 
…verwrite old stub file
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jun 15, 2019
@tk0miya
Fix sphinx-doc#247: autosummary: Add autosummary_generate_option to o…
6c56c52 
…verwrite old stub file
@tk0miya tk0miya modified the milestones: 2.2.0, 3.0.0 Jun 15, 2019
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jun 15, 2019
@tk0miya
Fix sphinx-doc#247: autosummary: Add autosummary_generate_option to o…
c02aaf9 
…verwrite old stub file
@tk0miya tk0miya closed this as completed in 4af90fc Jul 7, 2019
tk0miya added a commit that referenced this issue Jul 7, 2019
@tk0miya
Merge pull request #6422 from tk0miya/247_autosummary_autorewrite
c9078fa 
Fix #247: autosummary: Add autosummary_generate_option to overwrite old stub file
@tk0miya
Copy link
Member

tk0miya commented Jul 7, 2019

Fixed by #6422. It will be released as 3.0 in future (for compatibility reasons, we have to wait a major release).

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions:autosummary type:enhancement enhance or introduce a new feature
Projects
None yet
Milestone
3.0.0
Development

No branches or pull requests
3 participants
@shimizukawa @tk0miya @Michael-E-Rose