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.

Sign up for GitHub

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

Jump to bottom

docs: add examples to docstrings #401

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft

docs: add examples to docstrings #401

wants to merge 18 commits into from

Commits on Nov 12, 2023

  1. docs: refactor whole rendering style

    @RaczeQ
    RaczeQ committed Nov 12, 2023
    Configuration menu
    Copy the full SHA
    350d616 View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into 392-add-examples-to-docstrings-in-classes-an… 

    …d-functions
    @RaczeQ
    RaczeQ authored Nov 12, 2023
    Configuration menu
    Copy the full SHA
    306fd26 View commit details
    Browse the repository at this point in the history

Commits on Nov 13, 2023

  1. ci: add black dependerncy to mkdocs generation

    @RaczeQ
    RaczeQ committed Nov 13, 2023
    Configuration menu
    Copy the full SHA
    09aab4c View commit details
    Browse the repository at this point in the history

  2. docs: add links to paragraphs

    @RaczeQ
    RaczeQ committed Nov 13, 2023
    Configuration menu
    Copy the full SHA
    a2f92ba View commit details
    Browse the repository at this point in the history

  3. docs: change styles for full api

    @RaczeQ
    RaczeQ committed Nov 13, 2023
    Configuration menu
    Copy the full SHA
    a1d1ae2 View commit details
    Browse the repository at this point in the history

Commits on Nov 14, 2023

  1. docs: disable doctest part selection

    @RaczeQ
    RaczeQ committed Nov 14, 2023
    Configuration menu
    Copy the full SHA
    1554d85 View commit details
    Browse the repository at this point in the history

Commits on Nov 22, 2023

  1. feat: make copying code from docs ignore >>> and code execution results

    @simonusher
    simonusher committed Nov 22, 2023
    Configuration menu
    Copy the full SHA
    185985a View commit details
    Browse the repository at this point in the history

  2. chore: refactor function names

    @simonusher
    simonusher committed Nov 22, 2023
    Configuration menu
    Copy the full SHA
    2377614 View commit details
    Browse the repository at this point in the history

  3. Merge branch 'main' into 392-add-examples-to-docstrings-in-classes-an… 

    …d-functions
    @RaczeQ
    RaczeQ authored Nov 22, 2023
    Configuration menu
    Copy the full SHA
    7782ab8 View commit details
    Browse the repository at this point in the history

Commits on Nov 27, 2023

  1. Merge branch 'main' into 392-add-examples-to-docstrings-in-classes-an… 

    …d-functions
    @RaczeQ
    RaczeQ authored Nov 27, 2023
    Configuration menu
    Copy the full SHA
    dbf988e View commit details
    Browse the repository at this point in the history

Commits on Nov 29, 2023

  1. Merge branch 'main' into 392-add-examples-to-docstrings-in-classes-an… 

    …d-functions
    @RaczeQ
    RaczeQ authored Nov 29, 2023
    Configuration menu
    Copy the full SHA
    0f43d11 View commit details
    Browse the repository at this point in the history

  2. chore: add pytest-doctestplus dependency

    @RaczeQ
    RaczeQ committed Nov 29, 2023
    Configuration menu
    Copy the full SHA
    62857ff View commit details
    Browse the repository at this point in the history

  3. test: incorporate doctests into pytest

    @RaczeQ
    RaczeQ committed Nov 29, 2023
    Configuration menu
    Copy the full SHA
    09d7299 View commit details
    Browse the repository at this point in the history

Commits on Dec 6, 2023

  1. chore: change geocode_to_region_gdf doctests

    @RaczeQ
    RaczeQ committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    4f6aaa9 View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into 392-add-examples-to-docstrings-in-classes-an… 

    …d-functions
    @RaczeQ
    RaczeQ authored Dec 6, 2023
    Configuration menu
    Copy the full SHA
    75837ec View commit details
    Browse the repository at this point in the history

  3. chore: change H3Neighbourhood import path

    @RaczeQ
    RaczeQ committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    5b9c256 View commit details
    Browse the repository at this point in the history

  4. Merge branch '392-add-examples-to-docstrings-in-classes-and-functions… 

    …' of https://github.com/kraina-ai/srai into 392-add-examples-to-docstrings-in-classes-and-functions
    @RaczeQ
    RaczeQ committed Dec 6, 2023
    Configuration menu
    Copy the full SHA
    3bd5b59 View commit details
    Browse the repository at this point in the history

Commits on Dec 7, 2023

  1. chore: split running tests and doctests together

    @RaczeQ
    RaczeQ committed Dec 7, 2023
    Configuration menu
    Copy the full SHA
    e7121fe View commit details
    Browse the repository at this point in the history