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

Styling for reference generated using Autodoc #230

Merged
merged 1 commit into from
Oct 26, 2022
Merged

Conversation

Temidayo32
Copy link
Contributor

This pull request addresses an indentation problem ( issue #228) when using sphinx.ext.autodoc to generate documentation automatically from the source code.

Copy link
Member

@lb- lb- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Temidayo32 this is a good start but we will have to make some tweaks to get this in.

dl.class {
  .sig-object + dd {
    margin: 0 0 0.5rem 1.5rem;
  }
}

This approach does a few things differently - it 'scopes' the styles to only the elements we care about and also uses rems for margins to ensure we nicely support different zoom & font sizes.

Copy link
Member

@lb- lb- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will merge this in with the recommended changes for now and we can discuss more on the other PR.

Also - please let me know your preferred name for the changelog, I could not find a name on your git commit nor your GitHub profile.

@lb- lb- merged commit 9f6e71a into wagtail:main Oct 26, 2022
@Temidayo32
Copy link
Contributor Author

Thanks @lb- for the feedback. I will immediately make the changes and get back to you soonest.

@Temidayo32
Copy link
Contributor Author

My preferred is Temidayo, or my full name of you want, Temidayo Azeez

@Temidayo32 Temidayo32 mentioned this pull request Oct 27, 2022
lb- added a commit that referenced this pull request Oct 27, 2022
@lb-
Copy link
Member

lb- commented Oct 27, 2022

Changelog added 0368547

@thibaudcolas thibaudcolas added the Outreachy https://www.outreachy.org/ label Nov 23, 2022
thibaudcolas pushed a commit to Temidayo32/sphinx_wagtail_theme that referenced this pull request Mar 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Outreachy https://www.outreachy.org/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants