-
Notifications
You must be signed in to change notification settings - Fork 29
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
Autodoc indentation/formatting issue #228
Comments
@thibaudcolas @Scotchester @lb- I would like to work on the issue if provided with directions on where to look to solve the issue. I would think the issue might be from the layout though |
@Temidayo32 happy for you to suggest a few ideas - or maybe see what other python project documentation does for this kind of output. |
@lb- So with indentation handled, the possible other styling to consider would be color highlighting for the classes and their methods |
Sorry for the delay - let's keep this open for now and see if we can get your formatting PR through before closing this. Thanks @Temidayo32 |
Some progress was done on #235 - see feedback there and anyone is free to pick up where that left off. |
In a draft pull request I made, generating a reference documentation for StreamField automatically using
sphinx.ext.autodoc
, the documentation was not properly indented.Actual behaviour
The methods and classes the methods belong to were on the same indentation level.
Expected behaviour
The methods should be nested inside of the classes they belong to.
The text was updated successfully, but these errors were encountered: