Skip to content

Support property (autodoc, py-domain)#6320

Merged
tk0miya merged 4 commits intosphinx-doc:2.0from
tk0miya:refactor_py_domain3
May 13, 2019
Merged

Support property (autodoc, py-domain)#6320
tk0miya merged 4 commits intosphinx-doc:2.0from
tk0miya:refactor_py_domain3

Conversation

@tk0miya
Copy link
Copy Markdown
Member

@tk0miya tk0miya commented Apr 23, 2019

Feature or Bugfix

  • Feature

Purpose

  • Add :property: option to py:method directive
  • autodoc supports property detection

@tk0miya tk0miya added type:enhancement enhance or introduce a new feature extensions:autodoc domains:py labels Apr 23, 2019
@tk0miya tk0miya added this to the 2.1.0 milestone Apr 23, 2019
@tk0miya tk0miya force-pushed the refactor_py_domain3 branch from 52fe617 to bfe129c Compare April 25, 2019 12:31
@tk0miya tk0miya force-pushed the refactor_py_domain3 branch from bfe129c to b708f7b Compare May 12, 2019 07:00
@codecov
Copy link
Copy Markdown

codecov bot commented May 12, 2019 •
edited
Loading

Codecov Report

Merging #6320 into 2.0 will increase coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##              2.0    #6320      +/-   ##
==========================================
+ Coverage   83.64%   83.66%   +0.01%     
==========================================
  Files         277      277              
  Lines       40087    40125      +38     
  Branches     5912     5916       +4     
==========================================
+ Hits        33531    33569      +38     
  Misses       5225     5225              
  Partials     1331     1331
Impacted Files Coverage Δ
tests/test_autodoc.py 96.88% <ø> (ø) ⬆️
tests/test_util_inspect.py 92.71% <100%> (+0.19%) ⬆️
sphinx/util/inspect.py 72.29% <100%> (+0.15%) ⬆️
sphinx/ext/autosummary/generate.py 75.34% <100%> (+0.34%) ⬆️
sphinx/ext/autodoc/__init__.py 88.77% <100%> (+0.22%) ⬆️
sphinx/domains/python.py 74.48% <100%> (+0.26%) ⬆️
tests/test_domain_py.py 99.14% <100%> (+0.01%) ⬆️

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 935d1ad...19a006f. Read the comment docs.

tk0miya
tk0miya commented May 12, 2019
View reviewed changes
sphinx/ext/autosummary/generate.py
if isinstance(typ, str):
types = {typ}
else:
types = typ
Copy link
Copy Markdown
Member Author

@tk0miya tk0miya May 12, 2019

Choose a reason for hiding this comment

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

This is a bit ugly. I'll modify this in another PR.

shimizukawa
shimizukawa approved these changes May 12, 2019
View reviewed changes
Copy link
Copy Markdown
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.

LGTM!

@tk0miya
Copy link
Copy Markdown
Member Author

tk0miya commented May 13, 2019

Thank you for reviewing. Merging.

@tk0miya tk0miya merged commit e32a610 into sphinx-doc:2.0 May 13, 2019
@tk0miya tk0miya mentioned this pull request May 13, 2019
Merged
@tk0miya tk0miya deleted the refactor_py_domain3 branch May 13, 2019 04:54
This was referenced Jan 27, 2020
Closed
Closed
@tk0miya tk0miya mentioned this pull request Apr 20, 2020
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@shimizukawa shimizukawa shimizukawa approved these changes

Assignees

No one assigned

Labels

domains:py extensions:autodoc type:enhancement enhance or introduce a new feature

Projects

None yet

Milestone

2.1.0

Development

Successfully merging this pull request may close these issues.

2 participants

@tk0miya @shimizukawa