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.

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

Figure out why obj's subclassing yamlize things have doc error: Inline emphasis start-string without end-string. #481

Closed
ntouran opened this issue Nov 19, 2021 · 2 comments · Fixed by SimplyKnownAsG/yamlize#13
Assignees
Labels
bug Something is wrong: Highest Priority documentation Improvements or additions to documentation

Comments

@ntouran
Copy link
Member

ntouran commented Nov 19, 2021

In building the docs, almost things that subclass from yamlize objects show up with an warning along the lines of:

armi/reactor/blueprints/gridBlueprint.py:docstring of armi.reactor.blueprints.gridBlueprint.Grids:3: WARNING: Inline emphasis start-string without end-string. 

But the strange thing is that this object has no docstring at all!

class Grids(yamlize.KeyedList):
    item_type = GridBlueprint
    key_attr = GridBlueprint.name

And, by inspection, no docstring seems to be getting added at runtime:

>>> from armi.reactor.blueprints.gridBlueprint import Grids
>>> Grids.__doc__

>>>

So, what's going on!?

@ntouran ntouran added bug Something is wrong: Highest Priority documentation Improvements or additions to documentation labels Nov 19, 2021
@ntouran ntouran self-assigned this Nov 19, 2021
@ntouran
Copy link
Member Author

ntouran commented Nov 19, 2021

Ok so I think what's happening here is that the autodoc is combining the class docstring with the __init__ docstring, which is inherited from here: https://github.com/SimplyKnownAsG/yamlize/blob/040c5cb70d8717b75022cb821e5acb7cad2606e6/yamlize/maps.py#L63 and which appears to be goofing up based on the *args thing which looks to sphinx like the start of italics with no ending.

@ntouran
Copy link
Member Author

ntouran commented Nov 20, 2021

Cool so the fix for this is merged in yamlize. This issue will go away if we install the latest yamlize from the master branch (pending next release to pypi).

@ntouran ntouran closed this as completed Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something is wrong: Highest Priority documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant