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

docs: the messages module is missing references #208

Closed
sergiusens opened this issue Dec 1, 2023 · 1 comment · Fixed by #212
Closed

docs: the messages module is missing references #208

sergiusens opened this issue Dec 1, 2023 · 1 comment · Fixed by #212

Comments

@sergiusens
Copy link
Collaborator

A picture is worth a 1000+ words

What I see
image

what is missing
image

Reported from: https://canonical-craft-cli.readthedocs-hosted.com/en/latest/craft_cli.messages/
@sergiusens
Copy link
Collaborator Author

__all__ might be too strict

tigarmo added a commit that referenced this issue Dec 8, 2023
@tigarmo
docs: fix missing api reference for Emitter
cc0899c 
The docs were missing because of the ``__all__`` attribute in
``messages.py``. To get around this, craft a special purpose rst file to
be used when documenting that module, explicitly asking autodoc to
generate docs for Emitter and EmitterMode.

Fixes #208
@tigarmo tigarmo mentioned this issue Dec 8, 2023
Merged
3 tasks
tigarmo added a commit that referenced this issue Dec 11, 2023
@tigarmo
docs: fix missing api reference for Emitter
9b9057c 
The docs were missing because of the ``__all__`` attribute in
``messages.py``. To get around this, craft a special purpose rst file to
be used when documenting that module, explicitly asking autodoc to
generate docs for Emitter and EmitterMode.

Fixes #208
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: fix missing api reference for Emitter canonical/craft-cli
1 participant
@sergiusens