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

Docs Refresh #540

Merged
merged 14 commits into from
May 27, 2022
Merged

Docs Refresh #540

merged 14 commits into from
May 27, 2022

Conversation

willmcgugan
Copy link
Collaborator

@willmcgugan willmcgugan commented May 25, 2022

Please don't proof read the docs just yet. Will request that in a later updated

  • Updated mkdocs and associated libs
  • Defines a structure in the docs
  • Adds a few docs, and a mkdocs plugin to render a screenshot to SVG
  • Removes style parameter from render method
  • Fixes issue with simple case of widget on an App

@willmcgugan willmcgugan marked this pull request as draft May 25, 2022 14:37
@willmcgugan willmcgugan requested review from olivierphi and darrenburns and removed request for olivierphi May 27, 2022 09:49
@willmcgugan willmcgugan marked this pull request as ready for review May 27, 2022 09:49
@willmcgugan willmcgugan changed the title WIP Docs Docs Refresh May 27, 2022
Copy link

@olivierphi olivierphi left a 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:
Screenshot from 2022-05-27 11-32-59

It seems that just setting line-height: 1; to a h2.doc.doc-heading selector does the job?
Screenshot from 2022-05-27 11-33-06

(it seems that we can simply add a extra.css file in the docs folder make it be picked automatically by MKDocs? - doc)

docs/introduction.md Outdated Show resolved Hide resolved
@darrenburns
Copy link
Member

@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]>
@willmcgugan
Copy link
Collaborator Author

There is definitely room for tweaking those API reference pages. They don't look great. Will come back to it.

@willmcgugan willmcgugan merged commit b806779 into css May 27, 2022
@willmcgugan willmcgugan deleted the docs-structure branch May 27, 2022 11:01
@pawamoy
Copy link
Contributor

pawamoy commented May 27, 2022

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.

@willmcgugan
Copy link
Collaborator Author

Thanks Timothée!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants