Skip to content

Commit

Permalink
dependencies mistake fixed + lint
Browse files Browse the repository at this point in the history
  • Loading branch information
ZergLev committed Sep 27, 2024
1 parent daa496c commit 3887383
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 11 deletions.
8 changes: 3 additions & 5 deletions docs/source/utils/generate_tutorials.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
from pathlib import Path
from shutil import copy
from typing import List, Optional, Set, Union, Tuple


Expand Down Expand Up @@ -83,7 +82,8 @@ def sort_key(tutorial_file_name: Path) -> float:

def iterate_tutorials_dir_generating_links(source: Path, dest: Path, base: str) -> List[Path]:
"""
Recursively travel through tutorials directory, creating copies for all files under /tmp_dir/docs/source/tutorials/ root.
Recursively travel through tutorials directory, creating copies
for all files under /tmp_dir/docs/source/tutorials/ root.
Created copied files have absolute path name matching source file tree structure.
:param source: Tutorials root (usually tutorials/).
Expand Down Expand Up @@ -141,6 +141,4 @@ def generate_tutorial_links_for_notebook_creation(
filtered_links += [link]

for included in include:
create_index_file(
included, filtered_links, dest / Path(f"index_{included[1].replace(' ', '_').lower()}.rst")
)
create_index_file(included, filtered_links, dest / Path(f"index_{included[1].replace(' ', '_').lower()}.rst"))
10 changes: 5 additions & 5 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions scripts/clean.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from pathlib import Path
import shutil


# This functions cleans the outdated docs during local build
def clean_docs(output_dir: str = ""):
shutil.rmtree("docs/build/" + output_dir, ignore_errors=True)
Expand All @@ -11,6 +12,7 @@ def clean_docs(output_dir: str = ""):
shutil.rmtree("docs/source/_static/drawio", ignore_errors=True)
shutil.rmtree("docs/source/drawio_src/**/export", ignore_errors=True)


# Ignored this function since it's unused.
def clean():
clean_docs()
Expand Down
1 change: 0 additions & 1 deletion scripts/doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import dotenv
import scripts.patch_sphinx # noqa: F401
import sphinx.ext.apidoc as apidoc
import sphinx.cmd.build as build
from colorama import init, Fore, Style
from python_on_whales import DockerClient

Expand Down

0 comments on commit 3887383

Please sign in to comment.