Merge pull request #90 from simbilod/docs

purge old docs

Author: simbilod

.github/workflows/pages.yml

@@ -9,26 +9,27 @@ on:
 jobs:
   build-docs:
     runs-on: ubuntu-latest
-    name: Sphinx docs to gh-pages
+    name: Build docs
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.10'
-          cache: "pip"
-          cache-dependency-path: pyproject.toml
-      - name: Installing the library
-        shell: bash -l {0}
+      - uses: actions/checkout@v2
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+      - name: Set up Python 3.12
+        run: uv python install 3.12
+      - name: Install venv
+        run: uv venv
+      - name: Install dependencies
         run: |
-          make gmsh-ubuntu dev
+          sudo apt-get install libglu1-mesa
+          uv pip install -e ".[dev]"
       - name: make docs
         run: |
-          make docs
+          jupyter-book build docs/ --all
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
           path: "./docs/_build/html/"
+
   deploy-docs:
     needs: build-docs
     permissions:

docs/_config.yml

@@ -1,59 +1,48 @@
 # Book settings
 # Learn more at https://jupyterbook.org/customize/config.html
 
-title: meshwell
-author: Simon Bilodeau
-copyright: "2023"
-logo: ../meshwell.png
+title: My sample book
+author: The Jupyter Book Community
+logo: logo.png
 
 # Force re-execution of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
 execute:
-  execute_notebooks: cache
-  timeout: -1
-  allow_errors: true
-  # execute_notebooks: force
-  # execute_notebooks: "off"
-  # exclude_patterns:
-  #   - '*notebooks/devsim/01_pin_waveguide*'
+  execute_notebooks: force
+  exclude_patterns:
+    - 'gdsfactory_interface'
 
+# Define the name of the latex output file for PDF builds
 latex:
-  latex_engine: pdflatex # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex'
-  use_jupyterbook_latex: true # use sphinx-jupyterbook-latex for pdf builds as default
+  latex_documents:
+    targetname: book.tex
 
-html:
-  home_page_in_navbar: true
-  use_edit_page_button: true
-  use_repository_button: true
-  use_issues_button: true
-  baseurl: https://github.com/joamatab/cookiecutter-pypackage-minimal
+# Add a bibtex file so that we can create citations
+bibtex_bibfiles:
+  - references.bib
 
 # Information about where the book exists on the web
 repository:
-  url: https://github.com/simbilod/meshwell
-  path_to_book: docs # Optional path to your book, relative to the repository root
-  branch: main # Which branch of the repository should be used when creating links (optional)
+  url: https://github.com/executablebooks/jupyter-book  # Online location of your book
+  path_to_book: docs  # Optional path to your book, relative to the repository root
+  branch: master  # Which branch of the repository should be used when creating links (optional)
 
-launch_buttons:
-  notebook_interface: jupyterlab
-  colab_url: "https://colab.research.google.com"
+# Add GitHub buttons to your book
+# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
+html:
+  use_issues_button: true
+  use_repository_button: true
 
 sphinx:
-  extra_extensions:
-    - "sphinx.ext.autodoc"
-    - "sphinx.ext.autodoc.typehints"
-    - "sphinx.ext.autosummary"
-    - "sphinx.ext.napoleon"
-    - "sphinx.ext.viewcode"
-    - "matplotlib.sphinxext.plot_directive"
-    - "sphinx_click"
-    - "sphinxcontrib.autodoc_pydantic"
   config:
-    #autodoc_typehints: description
-    autodoc_type_aliases:
-      "ComponentSpec": "ComponentSpec"
-    nb_execution_show_tb: True
+    html_js_files:
+    - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
+    mime_types:
+      application/vnd.plotly.v1+json: plotly
     nb_custom_formats:
-        .py:
+        .Rmd:
+            - jupytext.reads
+            - fmt: Rmd
+        .py:  # Add this line to include Python files
             - jupytext.reads
             - fmt: py

docs/_toc.yml

@@ -2,20 +2,11 @@
 # Learn more at https://jupyterbook.org/customize/toc.html
 
 format: jb-book
-root: index
-parts:
-  - caption: Quickstart
-    chapters:
-      - file: api/00_installation
-      - file: api/01_quickstart
-  - caption: Objects
-    chapters:
-      - file: api/02_polysurfaces
-      - file: api/03_prisms
-  - caption: Meshing
-    chapters:
-      - file: api/04_basics
-      - file: api/05_boundary_conditions
-  - caption: Reference
-    chapters:
-      - file: changelog
+root: intro
+chapters:
+- file: intro_gmsh
+- file: polysurfaces
+- file: prisms
+- file: models
+- file: resolution
+- file: gdsfactory_interface