Skip to content

Commit

Permalink
Update docs that references edn, protobuf
Browse files Browse the repository at this point in the history
  • Loading branch information
m.kindritskiy committed Sep 15, 2024
1 parent c62774c commit 215656e
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 23 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ENV PDM_USE_VENV=no
ENV PYTHONPATH=/work/__pypackages__/3.7/lib

RUN apt-get update && apt-get install -y libpq-dev && \
pip install --upgrade pip==${PIP_VERSION} && pip install pdm==${PDM_VERSION}
pip install --upgrade pip==${PIP_VERSION} && pip install pdm==${PDM_VERSION}

# for pyproject.toml to extract version
COPY hiku/__init__.py ./hiku/__init__.py
Expand All @@ -26,7 +26,7 @@ RUN pdm sync -G dev

FROM base as docs

RUN pdm sync -G docs
RUN pdm sync -G dev -G docs

FROM base as tests

Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Highlights
~~~~~~~~~~

* Not coupled to a single specific query language
* Flexibility in result serialization, including binary formats
* Flexibility in result serialization
* Natively uses normalized result representation, without data duplication
* All concurrency models supported: coroutines, threads
* Parallel query execution
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: '3.7'
version: "3.7"

services:
base: &base
Expand Down
36 changes: 17 additions & 19 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
]

autoclass_content = 'both'
autodoc_member_order = 'bysource'
autoclass_content = "both"
autodoc_member_order = "bysource"

intersphinx_mapping = {
'python': ('https://docs.python.org/3.6', None),
'aiopg': ('http://aiopg.readthedocs.io/en/stable', None),
'sqlalchemy': ('http://docs.sqlalchemy.org/en/rel_1_1', None),
"python": ("https://docs.python.org/3.6", None),
"aiopg": ("http://aiopg.readthedocs.io/en/stable", None),
"sqlalchemy": ("http://docs.sqlalchemy.org/en/rel_1_1", None),
}

source_suffix = '.rst'
master_doc = 'index'
source_suffix = ".rst"
master_doc = "index"

project = 'hiku'
copyright = '2019, Vladimir Magamedov'
author = 'Vladimir Magamedov'
project = "hiku"
copyright = "2019, Vladimir Magamedov"
author = "Vladimir Magamedov"

templates_path = []

html_theme = 'furo'
html_static_path = ['_static']
html_theme_options = {
'display_version': False,
}
html_theme = "furo"
html_static_path = ["_static"]
html_theme_options = {}


def setup(app):
app.add_css_file('style.css?r=1')
app.add_css_file('fixes.css?r=1')
app.add_css_file("style.css?r=1")
app.add_css_file("fixes.css?r=1")
2 changes: 2 additions & 0 deletions docs/reference/readers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: hiku.readers.graphql
:members: read, read_operation, Operation, OperationType
7 changes: 7 additions & 0 deletions hiku/readers/graphql.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
"""
hiku.readers.graphql
~~~~~~~~~~~~~~~~~~~~
Support for queries encoded using GraphQL syntax.
"""
from typing import Any, cast, Dict, Iterator, List, Optional, Set, Union

from graphql.language import ast
Expand Down

0 comments on commit 215656e

Please sign in to comment.