Update doc and create placeholders

claudezss · Jun 12, 2023 · f69730a · f69730a
1 parent 38f414b
commit f69730a
Show file tree

Hide file tree

Showing 14 changed files with 89 additions and 122 deletions.
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/blog/posts/.gitkeep b/docs/blog/posts/.gitkeep
diff --git a/docs/experiments/create_network.ipynb b/docs/experiments/create_network.ipynb
@@ -0,0 +1,52 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "source": [
+    "# Create Power Network\n"
+   ],
+   "metadata": {
+    "collapsed": false
+   }
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "## WIP\n"
+   ],
+   "metadata": {
+    "collapsed": false
+   }
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "outputs": [],
+   "source": [],
+   "metadata": {
+    "collapsed": false
+   }
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 2
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython2",
+   "version": "2.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 0
+}
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,5 @@
+# Home
+
+## Welcome to PyOhm Ω
+
+A python library to create simple power grid and calculate powerflow.
diff --git a/docs/knowledge_base/machine_learning/index.md b/docs/knowledge_base/machine_learning/index.md
@@ -0,0 +1 @@
+# [WIP] Machine Learning 
diff --git a/docs/knowledge_base/power_system/index.md b/docs/knowledge_base/power_system/index.md
@@ -0,0 +1 @@
+# [WIP] Power System
diff --git a/docs/knowledge_base/powerflow/index.md b/docs/knowledge_base/powerflow/index.md
@@ -0,0 +1 @@
+# [WIP] Powerflow
diff --git a/docs/knowledge_base/programming/index.md b/docs/knowledge_base/programming/index.md
@@ -0,0 +1,7 @@
+# Programming
+
+## Papers
+
+- [Performance Comparisons of Parallel Power Flow Solvers on GPU System](https://ieeexplore.ieee.org/document/6300155)
+- [Comparing Different Approaches for Solving Large Scale Power-Flow Problems With the Newton-Raphson Method](https://ieeexplore.ieee.org/document/9399417)
+
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/docs/source/refs/index.md b/docs/source/refs/index.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,20 @@
+site_name: PyOhm
+theme:
+  name: material
+  features:
+    - navigation.instant
+    - navigation.tabs
+plugins:
+  - search
+  - tags
+  - mknotebooks
+
+nav:
+  - Home: index.md
+  - Knowledge Base:
+      - Power System: knowledge_base/power_system/index.md
+      - Programming: knowledge_base/programming/index.md
+      - Machine Learning: knowledge_base/machine_learning/index.md
+      - Powerflow: knowledge_base/powerflow/index.md
+  - Experiments:
+      - Network: experiments/create_network.ipynb
diff --git a/pyproject.toml b/pyproject.toml
@@ -40,12 +40,9 @@ dependencies = [
 
 dev = ["pre-commit"]
 doc = [
-    "sphinx",
-    "myst-parser",
     "wheel",
-    "ipython",
-    "sphinx-multiversion",
-    "pydata-sphinx-theme",
+    "mkdocs-material",
+    "mknotebooks"
 ]
 test = [
     "pytest",