Fix classmethod property autodoc (#83) swev-id: sphinx-doc__sphinx-9461#87
Open
casey-brooks wants to merge 1 commit intosphinx-doc__sphinx-9461from
Open
Fix classmethod property autodoc (#83) swev-id: sphinx-doc__sphinx-9461#87casey-brooks wants to merge 1 commit intosphinx-doc__sphinx-9461from
casey-brooks wants to merge 1 commit intosphinx-doc__sphinx-9461from
Conversation
542ba52 to
1dc0f50
Compare
Author
Test & Lint Summary
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves #83.
Testing
PYTHONPATH=/workspace/sphinx pytest tests/test_ext_autodoc_autoproperty.pyPYTHONPATH=/workspace/sphinx pytest tests/test_ext_autosummary.py::test_autosummary_classmethod_propertiesPYTHONPATH=/workspace/sphinx pytest(fails: 23 pre-existing failures related to typing representation and linkcheck on Python 3.10)Reproduction notes
.. autoproperty:: demo_pkg.Example.tokenconfirming HTML output includes the classmethod property signature and docstring.git clone https://github.com/randolf-scholz/sphinx_democd sphinx_demo/docsmake html_build/html/dummy_module.submodule.htmlMetaClass.metaclass_class_propertyMetaClass.metaclass_abstract_class_propertyBaseClass.baseclass_class_propertyBaseClass.baseclass_abstract_class_propertySubClass.subclass_class_propertySubClass.subclass_abstract_class_property