set up autodocs

Julia Documentation

.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,59 @@
+name: Documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Sparlectra and Documenter packages
+        run: |
+          julia -e 'using Pkg; Pkg.add(["Sparlectra", "Documenter"])'
+
+      - name: Run make.jl script
+        run: julia docs/make.jl
+
+      - name: Copy build content to _site directory
+        run: |
+          mkdir -p _site/
+          cp -r docs/build/* ./_site/
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+
+      #- name: Upload _site directory as artifact
+      #  uses: actions/upload-artifact@v4
+      #  with:
+      #    name: site
+      #    path: ./_site/
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      #- name: Download _site artifact
+      #  uses: actions/download-artifact@v4
+      #  with:
+      #    name: site
+      #    path: _site/
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,9 +1,11 @@
+[![Documentation](https://github.com/Welthulk/Sparlectra.jl/actions/workflows/jekyll-gh-pages.yml/badge.svg)](https://welthulk.github.io/Sparlectra.jl/)
+
+
 # SPARLECTRA
 <a href="https://github.com/Welthulk/Sparlectra.jl/tree/main/"><img align="left" width="100" src="docs/src/assets/logo.png" style="margin-right: 20px" /></a>
 
 This package contains tools for subsequent network calculations. It primarily features a program for calculating load flow using the Newton-Raphson method. The focus is to provide valuable insights into load flow calculations for both students and ambitious professionals.
 
-
 ---
 
 ## Installation
@@ -12,11 +14,8 @@ using Pkg
 Pkg.add("Sparlectra")
 ```
 
-
 ### Network Creation
-This package supports the import and export of Matpower .m files, although currently it only reads bus, generator, and branch data from these files. Please note that additional Matlab functions within the .m file are not supported. Additionally, you can create your own network using easy-to-use functions provided by the package.
-
-
+This package supports the import and export of Matpower .m files, although currently it only reads bus, generator, and branch data from these files. Please note that additional Matlab functions within the .m file are not supported. Additionally, you can modify the imported Matpower files or you can create your own network using easy-to-use functions provided by the package.
 
 ### License
 This project is licensed under the BSD-3-Clause - [The license file](LICENSE) contains the complete licensing information.

docs/make.jl

@@ -15,8 +15,3 @@ makedocs(
     "changelog.md"
   ]
 )
-
-deploydocs(
-    repo = "github.com/Welthulk/Sparlectra.jl.git",
-    target = "build",
-)

docs/src/import.md

@@ -1,4 +1,4 @@
-Import and Export Netowrks Module
+Import and Export Network Configuration
 =============
 #### Importing a Matpower Network Configuration
 

docs/src/index.md

@@ -11,6 +11,7 @@ For installation, run the following command in the Julia REPL:
 import Pkg
 Pkg.add("Sparlectra")
 ```
+
 ---
 
 #### Contributors

docs/src/networks.md

@@ -1,4 +1,4 @@
-Netowrks Module
+Network Module
 =============
 The `Net` module provides functionality for creating and manipulating power system network models in Julia. It includes features for defining buses, branches, transformers, prosumers, and shunts, as well as methods for running power flow analysis.