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

autodoc: :meta public: does not effect to variables #8592

Closed
tk0miya opened this issue Dec 26, 2020 · 0 comments
Closed

autodoc: :meta public: does not effect to variables #8592

tk0miya opened this issue Dec 26, 2020 · 0 comments
Labels
extensions:autodoc type:bug
Milestone
3.5.0

Comments

@tk0miya
Copy link
Member

tk0miya commented Dec 26, 2020

Describe the bug
autodoc: :meta public: does not effect to variables.

To Reproduce

# example.py
_foo = None  #: :meta public:

# index.rst
.. automodule:: example
   :members:

I expect _foo is shown on the built document, but not shown.

Expected behavior
_foo should be shown on the built document.

Your project
No

Screenshots
No

Environment info

  • OS: Mac
  • Python version: 3.9.1
  • Sphinx version: HEAD of 3.x
  • Sphinx extensions: sphinx.ext.autodoc
  • Extra tools: No

Additional context
No
@tk0miya tk0miya added this to the 3.5.0 milestone Dec 26, 2020
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 27, 2020
@tk0miya
Fix sphinx-doc#8592: autodoc: :meta public: does not effect to vari…
0a156e7 
…ables

To control the visibility of variables, ModuleDocumenter have to load
docstring of them on `get_object_members()` phase.  This reimplements
it and `get_module_members()` helper to fetch docstring on earlier
phase (as ClassDocumenter does).
@tk0miya tk0miya mentioned this issue Dec 27, 2020
Merged
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 27, 2020
@tk0miya
Fix sphinx-doc#8592: autodoc: :meta public: does not effect to vari…
8803336 
…ables

To control the visibility of variables, ModuleDocumenter have to load
docstring of them on `get_object_members()` phase.  This reimplements
it and `get_module_members()` helper to fetch docstring on earlier
phase (as ClassDocumenter does).
tk0miya added a commit to tk0miya/sphinx that referenced this issue Dec 27, 2020
@tk0miya
Fix sphinx-doc#8592: autodoc: :meta public: does not effect to vari…
bdf9f60 
…ables

To control the visibility of variables, ModuleDocumenter have to load
docstring of them on `get_object_members()` phase.  This reimplements
it and `get_module_members()` helper to fetch docstring on earlier
phase (as ClassDocumenter does).
tk0miya added a commit that referenced this issue Dec 28, 2020
@tk0miya
Merge pull request #8593 from tk0miya/8592_meta_public_doesnt_affect_…
b19bce9 
…to_variables

Fix #8592: autodoc: `:meta public:` does not effect to variables
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions:autodoc type:bug
Projects
None yet
Milestone
3.5.0
Development

No branches or pull requests
1 participant
@tk0miya