Sphinx Doc-comments support #804
Open
Conversation
This file contains 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
This attribute was used to attach the right docstring node to the right Attribute object. Now it uses AST node navigation (with the .parent attribute) instead for fetching the docstring node for an ast.Assign. This change might not be worth it, on the one hand it removes a attribute beeing mutated at different palces in the code, but replaces this kind of "unsafe" state tracking (meaning not with pop() and push()) by some more verbose solution that involves adding the .parent attribute on all nodes. The zopeinferface extension needed to be adjusted as well because it relied on the docstring assigment feature in an implicit way, now it's explicit what we're doing.
…hpinx... Refactor for a better separation of docstring sources. And add a test.
|
@lod, this PR introduces support for doc-comments |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
…r into 800-doc-comments-support
This comment has been minimized.
This comment has been minimized.
|
This code obviously has a bug (the pydoctor_primer diff makes no sens)... Still to be worked on... |
This comment has been minimized.
This comment has been minimized.
tristanlatr
commented
Sep 22, 2024
tristanlatr
removed
the
pending
|
please review |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
I’de prefer if the implementation was using ast-comments so the astbuilder code is not mixed with token processing code. But this is not possible because of issues like this: t3rn0/ast-comments#13 . So I'm inclined to merge this implementation. |
This comment has been minimized.
This comment has been minimized.
This comment was marked as outdated.
This comment was marked as outdated.
|
Diff from pydoctor_primer, showing the effect of this PR on open source code: pydoctor (https://github.com/twisted/pydoctor)
+ /projects/pydoctor/pydoctor/epydoc/markup/restructuredtext.py:63: Existing docstring at line 31 is overriden
scrapy (https://github.com/scrapy/scrapy)
+ /projects/scrapy/scrapy/item.py:80: bad docstring: No role entry for "ref" in module "docutils.parsers.rst.languages.en".
+ Trying "ref" as canonical role name.
+ /projects/scrapy/scrapy/item.py:80: bad docstring: Unknown interpreted text role "ref".
- these 31 objects' docstrings contain syntax errors:
+ these 32 objects' docstrings contain syntax errors:
+ scrapy.Item.fields
bottle (https://github.com/bottlepy/bottle)
+ /projects/bottle/bottle.py:4502: Cannot find link target for "bottle_sqlite"
sphinx (https://github.com/sphinx-doc/sphinx)
+ /projects/sphinx/sphinx/locale/__init__.py:219: bad docstring: No role entry for "confval" in module "docutils.parsers.rst.languages.en".
+ Trying "confval" as canonical role name.
+ /projects/sphinx/sphinx/locale/__init__.py:219: bad docstring: Unknown interpreted text role "confval".
+ /projects/sphinx/sphinx/ext/autodoc/__init__.py:66: bad docstring: Literal block expected; none found.
+ /projects/sphinx/sphinx/project.py:33: bad docstring: No role entry for "confval" in module "docutils.parsers.rst.languages.en".
+ Trying "confval" as canonical role name.
+ /projects/sphinx/sphinx/project.py:33: bad docstring: Unknown interpreted text role "confval".
+ /projects/sphinx/sphinx/environment/__init__.py:992: bad docstring: Inline literal start-string without end-string.
+ /projects/sphinx/sphinx/environment/__init__.py:992: bad docstring: Inline literal start-string without end-string.
+ /projects/sphinx/sphinx/environment/__init__.py:1010: bad docstring: Inline literal start-string without end-string.
+ /projects/sphinx/sphinx/environment/__init__.py:1010: bad docstring: Inline literal start-string without end-string.
+ /projects/sphinx/sphinx/transforms/post_transforms/images.py:196: bad docstring: No directive entry for "todo" in module "docutils.parsers.rst.languages.en".
+ Trying "todo" as canonical directive name.
+ /projects/sphinx/sphinx/transforms/post_transforms/images.py:196: bad docstring: Unknown directive type "todo"... todo:: This should be refactored not to store the state without class
+ variable.
+ /projects/sphinx/sphinx/ext/intersphinx/_shared.py:36: bad docstring: No role entry for "confval" in module "docutils.parsers.rst.languages.en".
+ Trying "confval" as canonical role name.
+ /projects/sphinx/sphinx/ext/intersphinx/_shared.py:36: bad docstring: Unknown interpreted text role "confval".
+ /projects/sphinx/sphinx/addnodes.py:314: Cannot find link target for "_sig_element=True"
+ /projects/sphinx/sphinx/builders/__init__.py:92: Cannot find link target for "~.Builder.write_doc" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:92: Cannot find link target for "~.Builder.write_doc" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:78: Cannot find link target for ".SphinxPostTransform" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:78: Cannot find link target for ".SphinxPostTransform" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:78: Cannot find link target for ".SphinxPostTransform" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:78: Cannot find link target for ".SphinxPostTransform" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:92: Cannot find link target for "~.Builder.write_doc" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:78: Cannot find link target for ".SphinxPostTransform" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:92: Cannot find link target for "~.Builder.write_doc" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:78: Cannot find link target for ".SphinxPostTransform" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:78: Cannot find link target for ".SphinxPostTransform" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:92: Cannot find link target for "~.Builder.write_doc" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:87: Cannot find link target for "~sphinx.application.Sphinx.set_translator" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/builders/__init__.py:78: Cannot find link target for ".SphinxPostTransform" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/domains/__init__.py:104: Cannot find link target for "self.data" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/ext/intersphinx/_shared.py:29: Cannot find link target for "~sphinx.builder.html.INVENTORY_FILENAME" (you can link to external docs with --intersphinx)
+ /projects/sphinx/sphinx/locale/__init__.py:222: Cannot find link target for "LC_ALL"
+ /projects/sphinx/sphinx/locale/__init__.py:222: Cannot find link target for "LC_MESSAGES"
- these 66 objects' docstrings contain syntax errors:
+ these 73 objects' docstrings contain syntax errors:
+ sphinx.environment._CurrentDocument.c_namespace_stack
+ sphinx.environment._CurrentDocument.cpp_namespace_stack
+ sphinx.ext.autodoc.py_ext_sig_re
+ sphinx.ext.intersphinx._shared.IntersphinxMapping
+ sphinx.locale._
+ sphinx.project.Project.source_suffix
+ sphinx.transforms.post_transforms.images.ImageConverter.available
numpy (https://github.com/numpy/numpy)
+ /projects/numpy/numpy/typing/mypy_plugin.py:101: Cannot find link target for "numpy._core.intp", resolved from "np.intp"
+ /projects/numpy/numpy/typing/mypy_plugin.py:98: Cannot find link target for "numpy._core.number", resolved from "np.number"
|
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.
Fixes #800