Merge pull request #64 from UBC-MDS/59-publish-docs-to-website-with-gh-pages-branch

modified file

Author: Harrisonlee0530

.github/workflows/docs.yml

@@ -36,7 +36,6 @@ jobs:
 
       - name: Build API documentation
         run: |
-          cd docs
           quartodoc build
 
       - name: Render and Publish

docs/index.qmd

@@ -1,16 +1,5 @@
 ---
 title: root_finding
-jupyter:
-  jupytext:
-    text_representation:
-      extension: .qmd
-      format_name: quarto
-      format_version: '1.0'
-      jupytext_version: 1.16.7
-  kernelspec:
-    display_name: 522_proj
-    language: python
-    name: 522_proj
 ---
 
 ## Welcome to root_finding
@@ -53,4 +42,4 @@ print(f"Root: {root}")  # Should be approximately 2.0
 
 ## GitHub Repository
 
-Visit our [GitHub repository](https://github.com/Harrisonlee0530/root_finding) for source code and to report issues.
+Visit our [GitHub repository](https://github.com/Harrisonlee0530/root_finding) for source code and to report issues.

docs/objects.json

@@ -1,16 +1,5 @@
 ---
 title: API Reference
-jupyter:
-  jupytext:
-    text_representation:
-      extension: .qmd
-      format_name: quarto
-      format_version: '1.0'
-      jupytext_version: 1.16.7
-  kernelspec:
-    display_name: 522_proj
-    language: python
-    name: 522_proj
 ---
 
-{{< quartodoc-ref >}}
+{{< quartodoc-ref >}}

docs/reference.qmd

@@ -53,4 +53,5 @@ bisection.bisection.bisection(f, xmin, xmax, tol=1e-09, max_iter=500)
 
     >>> root = bisection(lambda x: 3*x**3 + 4*x**2 - 2*x - 2, 0, 2, max_iter = 500)
     >>> print(f"{root:.5f}")
-        0.74827
+        0.74827
+

docs/reference/bisection.bisection.bisection.qmd

@@ -1,16 +1,5 @@
 ---
 title: Tutorial
-jupyter:
-  jupytext:
-    text_representation:
-      extension: .qmd
-      format_name: quarto
-      format_version: '1.0'
-      jupytext_version: 1.16.7
-  kernelspec:
-    display_name: 522_proj
-    language: python
-    name: 522_proj
 ---
 
 ## Getting Started with root_finding

docs/tutorial.qmd

@@ -59,6 +59,8 @@ dev = [
 
 docs = [
     "quartodoc",
+    "jupyter",
+    "nbformat"
 ]
 
 build = [