Merge pull request #47 from EnergySystemsModellingLab/mdbook

Build and publish manual with mdBook

.github/workflows/docs.yml

@@ -20,14 +20,22 @@ jobs:
         uses: dtolnay/rust-toolchain@stable
       - name: Setup pages
         uses: actions/configure-pages@v5
-      - name: Build docs
-        run: cargo doc --no-deps
-      - name: Add redirect
-        run: echo '<meta http-equiv="refresh" content="0;url=muse2/index.html">' > target/doc/index.html
+      - name: Install mdBook
+        run: cargo install mdbook
+      - name: Build docs with mdBook
+        run: |
+          mdbook build
+      - name: Build API docs
+        run: |
+          cargo doc --no-deps
+
+          # Put API documentation in with book
+          rm -r book/api/*
+          mv target/doc/* book/api
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: target/doc
+          path: book
   deploy:
     name: Deploy
     environment:

.gitignore

@@ -12,3 +12,7 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+# mdBook output
+book/
+index.html

book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["Alex Dewar"]
+language = "en"
+multilingual = false
+src = "docs"
+title = "MUSE 2.0"

docs/SUMMARY.md

@@ -0,0 +1,5 @@
+# Summary
+
+[Introduction](./introduction.md)
+
+- [Chapter 1](./chapter_1.md)

docs/chapter_1.md

@@ -0,0 +1,3 @@
+# Chapter 1
+
+[Insert content here.]

docs/introduction.md

@@ -0,0 +1,9 @@
+# Introduction
+
+MUSE 2.0 is a tool for running simulations of energy systems, written in Rust. It is a slimmer and
+faster version of [the older MUSE tool].
+
+The [API docs are available here].
+
+[the older MUSE tool]: https://github.com/EnergySystemsModellingLab/MUSE_OS
+[API docs are available here]: ./api/muse2