added python-doc.md back to .gitignore

NREL · Jan 29, 2024 · 3dd509c · 3dd509c
1 parent e0c7ea5
commit 3dd509c
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 3,801 deletions.
diff --git a/.github/workflows/deploy-book.yaml b/.github/workflows/deploy-book.yaml
@@ -49,7 +49,7 @@ jobs:
       - name: Generate python docs
         working-directory: ${{runner.workspace}}/fastsim/
         run:
-          pydoc-markdown -I python/ -p fastsim --render-toc > docs/src/python-doc.md
+          pydoc-markdown -I python/ --render-toc > docs/src/python-doc.md
 
       - name: Setup Pages
         id: pages

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1 +1,2 @@
-book/
+book/
+src/python-doc.md
diff --git a/docs/src/how-to-update.md b/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-doc.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