Fix/pydoc in book

.github/workflows/deploy-book.yaml

@@ -38,13 +38,18 @@ jobs:
           curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
           rustup update
           cargo install --version ${MDBOOK_VERSION} mdbook
-      - name: Build python docs
+
+      - name: Install dependencies for python docs
         run: 
           sudo apt update
           sudo apt install pipx
           pipx ensurepath
           pipx install pydoc-markdown
-          pydoc-markdown -I python/ -p fastsim --render-toc > docs/src/python_docs.md
+
+      - name: Generate python docs
+        working-directory: ${{runner.workspace}}/fastsim/
+        run:
+          pydoc-markdown -I python/ --render-toc > docs/src/python-doc.md
 
       - name: Setup Pages
         id: pages

docs/.gitignore

@@ -1,2 +1,2 @@
 book/
-src/python_docs.md
+src/python-doc.md

docs/src/how-to-update.md

@@ -11,7 +11,7 @@ Run the following in the repository root directory:
 1. If any python files were modified, 
     1. Install [pipx](https://github.com/pypa/pipx#install-pipx)
     1. Install [pydoc-markdown](https://niklasrosenstein.github.io/pydoc-markdown/#installation-)
-    1. run `pydoc-markdown -I python/ -p fastsim --render-toc > docs/src/python_docs.md`. Do not modify this file manually. 
+    1. run `pydoc-markdown -I python/ --render-toc > docs/src/python-doc.md`. Do not modify this file manually. 
 1. Run `mdbook serve --open docs/`
 
 ## Publishing