-
Notifications
You must be signed in to change notification settings - Fork 826
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
Docs Refresh #540
Docs Refresh #540
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! 😍
As we were discussing, it could be nice to get rid of that odd spacing in the API documentation headers:
It seems that just setting line-height: 1;
to a h2.doc.doc-heading
selector does the job?
(it seems that we can simply add a extra.css
file in the docs folder make it be picked automatically by MKDocs? - doc)
@drbenton I actually like how far apart the text is at the moment, it was just the fact that there was the gaps in the colour behind the text that I thought was a little jarring 😄 |
Co-authored-by: Olivier Philippon <[email protected]>
There is definitely room for tweaking those API reference pages. They don't look great. Will come back to it. |
There are some options you could use to tweak the rendering of API reference, given you are using the new handler and not the legacy one: - mkdocstrings:
handlers:
python:
selection:
docstring_style: google
docstring_options:
ignore_init_summary: yes
rendering:
merge_init_into_class: yes
separate_signature: yes
line_length: 80 If Black is installed, the signatures are formatted, respecting the specified line length. |
Thanks Timothée! |
Please don't proof read the docs just yet. Will request that in a later updated
style
parameter from render method