fix tutoirals (#87)

* fix tutoirals

* upd workflow

* remove print

* lint

* fix?

Author: Samoed

.github/workflows/build-docs.yaml

@@ -49,12 +49,13 @@ jobs:
           poetry install --with docs
 
       - name: Run tests
+        if: github.event_name != 'workflow_dispatch'
         run: |
           echo "Testing documentation build..."
           make test-docs
 
       - name: Build documentation
-        if: ${{ github.ref == 'refs/heads/dev' }}
+        if: ${{ github.ref == 'refs/heads/dev' }} && github.event_name != 'workflow_dispatch'
         run: |
           make docs
 

Makefile

@@ -35,7 +35,7 @@ test-docs:
 	$(poetry) python -m sphinx build -b doctest docs/source docs/build/html
 
 .PHONY: serve-docs
-serve-docs: docs
+serve-docs:
 	$(poetry) python -m http.server -d docs/build/html 8333
 
 .PHONY: multi-version-docs
@@ -49,4 +49,4 @@ clean-docs:
 	rm -rf docs/source/user_guides
 
 .PHONY: all
-all: lint
+all: lint

docs/source/conf.py

@@ -168,8 +168,7 @@
 
 def setup(app: Sphinx) -> None:
     generate_versions_json(repo_root, BASE_URL)
-    user_guids_dir = app.srcdir / "docs" / "source" / "user_guides"
-
+    user_guids_dir = app.srcdir / "user_guides"
     generate_tutorial_links_for_notebook_creation(
         include=[
             (
@@ -185,4 +184,5 @@ def setup(app: Sphinx) -> None:
         source="user_guides",
         destination=user_guids_dir,
     )
+
     app.connect("autoapi-skip-member", skip_member)

docs/source/docs_utils/tutorials.py

@@ -1,5 +1,9 @@
+import logging
 from pathlib import Path
 
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
 
 def create_notebook_link(source: Path, destination: Path) -> None:
     """
@@ -136,4 +140,6 @@ 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"))
+        path = dest / Path(f"index_{included[1].replace(' ', '_').lower()}.rst")
+        logger.info("dest %s", path)
+        create_index_file(included, filtered_links, path)