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.

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

Fix #247: autosummary: Add autosummary_generate_option to overwrite old stub file #6422

Merged
merged 1 commit into from Jul 7, 2019

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Jun 1, 2019

Feature or Bugfix

  • Feature

Purpose

  • refs: autosummary: generated stub files are not re-written #247
  • Add autosummary_generate_option to skip, warn or overwrite for existing stub files.
  • IMO, it would be better to use warning by default. But it introduces a little breaking change. So this only adds config variables. And I will change the default settings to warning in 3.0.

@tk0miya tk0miya added extensions:autosummary type:enhancement enhance or introduce a new feature labels Jun 1, 2019
@tk0miya tk0miya added this to the 2.1.0 milestone Jun 1, 2019
@tk0miya tk0miya force-pushed the 247_autosummary_autorewrite branch from 5b50c8a to 29f5d6f Compare June 1, 2019 12:55
@codecov
Copy link

codecov bot commented Jun 1, 2019

Codecov Report

Merging #6422 into master will increase coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #6422      +/-   ##
==========================================
+ Coverage   84.34%   84.36%   +0.01%     
==========================================
  Files         264      263       -1     
  Lines       40208    40211       +3     
  Branches     5914     5913       -1     
==========================================
+ Hits        33913    33922       +9     
+ Misses       4990     4987       -3     
+ Partials     1305     1302       -3
Impacted Files Coverage Δ
tests/test_ext_autosummary.py 98.72% <100%> (+0.16%) ⬆️
sphinx/ext/autosummary/__init__.py 85.45% <100%> (+0.03%) ⬆️
sphinx/ext/autosummary/generate.py 79.75% <100%> (+0.59%) ⬆️
sphinx/__init__.py

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0890469...4af90fc. Read the comment docs.

@tk0miya tk0miya changed the title 247 autosummary autorewrite Fix #247: autosummary: Add autosummary_generate_option to overwrite old stub file Jun 1, 2019
@tk0miya tk0miya modified the milestones: 2.1.0, 2.2.0 Jun 2, 2019
@tk0miya tk0miya force-pushed the 247_autosummary_autorewrite branch from 29f5d6f to 860ada4 Compare June 2, 2019 12:53
@tk0miya tk0miya force-pushed the 247_autosummary_autorewrite branch from 860ada4 to 0e69076 Compare June 15, 2019 16:34
@tk0miya tk0miya modified the milestones: 2.2.0, 3.0.0 Jun 15, 2019
@tk0miya tk0miya force-pushed the 247_autosummary_autorewrite branch from 0e69076 to c02aaf9 Compare June 15, 2019 16:35
@tk0miya tk0miya changed the base branch from 2.0 to master June 15, 2019 16:35
@tk0miya tk0miya closed this Jun 15, 2019
@tk0miya tk0miya reopened this Jun 15, 2019
Copy link
Member

@shimizukawa shimizukawa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for autosummary_generate_overwrite.
LGTM!

@tk0miya tk0miya force-pushed the 247_autosummary_autorewrite branch from c02aaf9 to 4af90fc Compare July 7, 2019 07:20
@tk0miya tk0miya merged commit c9078fa into sphinx-doc:master Jul 7, 2019
@tk0miya tk0miya deleted the 247_autosummary_autorewrite branch July 7, 2019 07:38
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
extensions:autosummary type:enhancement enhance or introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants