Skip to content

Commit

Permalink
Adding image and resolvers (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
rmyers committed Jan 4, 2024
1 parent 0dd0abf commit edc0c3b
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
Binary file added docs/_static/mind-map.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@
html_theme = "pydata_sphinx_theme"

html_theme_options = {
"logo": {
"text": "Cannula Documentation",
"image_light": "_static/mind-map.png",
"image_dark": "_static/mind-map.png",
},
"primary_sidebar_end": ["indices.html", "sidebar-ethical-ads.html"],
"external_links": [
{
Expand Down
18 changes: 18 additions & 0 deletions docs/resolvers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Resolvers
=========

Resolvers define how to fetch the data defined in your schema. There are many
ways to access your data but resolvers are just a simple async function that
return either an object or a dictionary that matches the shape of the Schema
return type.

This could be the raw json response from a third party library or it could be
a database model that represents your data. The great thing about resolvers
are they are completely flexible as long as the type you are returning is correct.
Which means you can combine loosly related items into a single parent.

.. toctree::
:maxdepth: 2

.. automodule:: cannula.api
:members:

0 comments on commit edc0c3b

Please sign in to comment.