Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benroberts999 committed Jul 12, 2024
1 parent 16c2fe5 commit b95c291
Show file tree
Hide file tree
Showing 19 changed files with 871 additions and 1,291 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs-dry.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ jobs:
for FILE in ./doc/*.md; do sed -i 's%(/doc/%(doc/%g' $FILE; done
for FILE in ./doc/*.md; do sed -i 's%(/README%(README%g' $FILE; done
for FILE in ./doc/*.md; do sed -i 's%(/src/%(https://github.com/benroberts999/ampsci/tree/main/src/%g' $FILE; done
for FILE in ./doc/*.md; do sed -i 's%::::%\brief%g' $FILE; done
for FILE in ./doc/tutorial*.md; do sed -i -e 's/\$\$~/\\f\[/g' $FILE; done
for FILE in ./doc/tutorial*.md; do sed -i -e 's/~\$\$/\\f\]/g' $FILE; done
for FILE in ./doc/tutorial*.md; do sed -i -e 's/\$/\\f\$/g' $FILE; done
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
for FILE in ./doc/*.md; do sed -i 's%(/doc/%(doc/%g' $FILE; done
for FILE in ./doc/*.md; do sed -i 's%(/README%(README%g' $FILE; done
for FILE in ./doc/*.md; do sed -i 's%(/src/%(https://github.com/benroberts999/ampsci/tree/main/src/%g' $FILE; done
for FILE in ./doc/*.md; do sed -i 's%::%\brief%g' $FILE; done
for FILE in ./doc/*.md; do sed -i 's%::::%\brief%g' $FILE; done
for FILE in ./doc/tutorial*.md; do sed -i -e 's/\$\$~/\\f\[/g' $FILE; done
for FILE in ./doc/tutorial*.md; do sed -i -e 's/~\$\$/\\f\]/g' $FILE; done
for FILE in ./doc/tutorial*.md; do sed -i -e 's/\$/\\f\$/g' $FILE; done
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ Divided into sections:

1. Usage intructions, input options
* Compilation instructions (for linux/mac/windows): [doc/compilation.md](doc/compilation.md)
* Detailed info on all input options: [doc/ampsci_input.md](doc/ampsci_input.md)

2. Physics documentation: [ampsci.dev/ampsci.pdf](https://ampsci.dev/ampsci.pdf)
* Description of physics/methods used in the code
Expand Down
Loading

0 comments on commit b95c291

Please sign in to comment.