Skip to content

Commit dbb0db8

Browse files
committed
Switch deployment to GitHub Pages under comp-physics org
1 parent 82385f8 commit dbb0db8

60 files changed

Lines changed: 17141 additions & 31 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.DS_Store

6 KB
Binary file not shown.

.github/workflows/deploy.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Deploy docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- uses: actions/setup-python@v5
21+
with:
22+
python-version: "3.12"
23+
24+
- name: Build docs
25+
run: |
26+
pip install zensical
27+
zensical build
28+
29+
- uses: actions/upload-pages-artifact@v3
30+
with:
31+
path: site/
32+
33+
deploy:
34+
needs: build
35+
runs-on: ubuntu-latest
36+
environment:
37+
name: github-pages
38+
url: ${{ steps.deployment.outputs.page_url }}
39+
steps:
40+
- id: deployment
41+
uses: actions/deploy-pages@v4

.readthedocs.yaml

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/group-syllabus/figures.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Companion documents: [Formatting your work](formatting.md)**
44

5-
See [here](https://github.com/sbryngelson/group-docs/tree/master/templates/paper/figures) for examples.
5+
See [here](https://github.com/comp-physics/group-docs/tree/master/templates/paper/figures) for examples.
66

77
## This seems like a lot of work. Why am I doing this?
88

@@ -22,7 +22,7 @@ These are TeX packages that provide a natural way to achieve consistency.
2222
There is a steep learning curve, though the trade-off is worth it compared to their competitors.
2323
The TeX stack exchange website regularly answers questions about these packages.
2424
A web search of almost any basic TikZ/PGF question will quickly flag an answer.
25-
I can provide example `.tex` files for many things (like [here](https://github.com/sbryngelson/group-docs/tree/master/templates/paper/figures)), and you can gather examples from your colleagues as well as online (like [here](https://github.com/comp-physics/tikz-examples) and [here](https://github.com/comp-physics/TikZ-examples-2)).
25+
I can provide example `.tex` files for many things (like [here](https://github.com/comp-physics/group-docs/tree/master/templates/paper/figures)), and you can gather examples from your colleagues as well as online (like [here](https://github.com/comp-physics/tikz-examples) and [here](https://github.com/comp-physics/TikZ-examples-2)).
2626

2727
Some other nice features:
2828

@@ -33,7 +33,7 @@ Some other nice features:
3333

3434
Compile all your figures as standalone PDF documents.
3535
This is handy for your paper and for using them in presentations and other media.
36-
With TikZ, this is quite easy, [here](https://github.com/sbryngelson/group-docs/blob/master/templates/paper/figures/slices.tex) is an example.
36+
With TikZ, this is quite easy, [here](https://github.com/comp-physics/group-docs/blob/master/templates/paper/figures/slices.tex) is an example.
3737
Here is a template of sorts:
3838
```tex
3939
\input{tikz_preamble}
@@ -47,7 +47,7 @@ Here is a template of sorts:
4747
4848
\end{document}
4949
```
50-
where I have a separate file called `tikz_preamble.tex` that you can find [here](https://github.com/sbryngelson/group-docs/blob/master/templates/paper/figures/tikz_preamble.tex) that holds the relevant packages I need and defined the document style.
50+
where I have a separate file called `tikz_preamble.tex` that you can find [here](https://github.com/comp-physics/group-docs/blob/master/templates/paper/figures/tikz_preamble.tex) that holds the relevant packages I need and defined the document style.
5151

5252
Use Tikz option:
5353

@@ -91,7 +91,7 @@ Place your sub-figure labels (e.g., (a) and (b)) in a place that is not too obtr
9191
* If you need sub-captions, you should put the sub-figure labels below the center of the figure.
9292

9393
Do not put the sub-figure captions directly below the sub-figures if you have no "real" caption (e.g., you are just labeling them (a) or (b), etc.); in this case, instead put them in one of the corners per above.
94-
See the examples [here](https://github.com/sbryngelson/group-docs/tree/master/templates/paper/figures) for reference.
94+
See the examples [here](https://github.com/comp-physics/group-docs/tree/master/templates/paper/figures) for reference.
9595

9696
Place a space between your sub-figure labels (e.g., (a, b) instead of (a,b)).
9797

docs/group-syllabus/formatting.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ You can connect them by placing `\input{preamble.tex}` at the top of your main t
3333
clause.
3434

3535
In the preamble file, you should include some packages.
36-
[Here](https://github.com/sbryngelson/group-docs/blob/master/templates/paper/preamble.tex) are some examples.
36+
[Here](https://github.com/comp-physics/group-docs/blob/master/templates/paper/preamble.tex) are some examples.
3737
Please look them up to see what they do.
3838

39-
For `elsarticle` class files (mine is included [here](https://github.com/sbryngelson/group-docs/blob/master/templates/paper/elsarticle.cls)), which I recommend you use, you need to organize the hyper-reference coloring a bit differently, which in that example document you will see in the preamble as well the top of `main.tex`
39+
For `elsarticle` class files (mine is included [here](https://github.com/comp-physics/group-docs/blob/master/templates/paper/elsarticle.cls)), which I recommend you use, you need to organize the hyper-reference coloring a bit differently, which in that example document you will see in the preamble as well the top of `main.tex`
4040

4141
```tex
4242
\documentclass[11pt,sort&compress]{elsarticle}
@@ -79,7 +79,7 @@ I usually put all of these in a single file that is invoked in the LaTeX preambl
7979
```tex
8080
\input{mathsymbols.tex}
8181
```
82-
and an example such file is in [`templates/paper/mathsymbols.tex`](https://github.com/sbryngelson/group-docs/blob/master/templates/paper/mathsymbols.tex) in this repository.
82+
and an example such file is in [`templates/paper/mathsymbols.tex`](https://github.com/comp-physics/group-docs/blob/master/templates/paper/mathsymbols.tex) in this repository.
8383

8484
Some notation rules you should follow
8585

@@ -150,7 +150,7 @@ Some examples and common errors:
150150
## Referencing your bibliography
151151
152152
Use `natbib` via `\usepackage{natbib}` (it is automatically loaded when one uses the `elsarticle` class).
153-
I recommend the bibliography style file in the template at [`templates/paper/bibsty.bst`](https://github.com/sbryngelson/group-docs/blob/master/templates/paper/bibsty.bst).
153+
I recommend the bibliography style file in the template at [`templates/paper/bibsty.bst`](https://github.com/comp-physics/group-docs/blob/master/templates/paper/bibsty.bst).
154154
This is automatically handled if you use the paper template in this repository.
155155
This way, you will have access to text and parenthetical citations, which render as:
156156
> One can partially address this problem by working in Fourier space [1] or fitting a parametric model to approximate the eddy diffusivity operator [21, 23]. However, the former requires spatial homogeneity, and the latter's accuracy depends on the parametric model's quality. Liu et al. [17] introduces an improved model that uses the nonlocal eddy diffusivity operator's moments to approximate the operator.
@@ -188,7 +188,7 @@ We generally want our references at the end of sentences unless they are part of
188188
* Use `bibtool` to remove unused entries from your bibliography (`.bib`) file
189189
* Remove all unused bibliography entries from your `.bib` file. To do this,
190190
* Make sure you have `bibtool` installed your your system
191-
* Copy a `bibtool.config` file to your document path, mine is located [here](https://github.com/sbryngelson/group-docs/blob/master/templates/paper/bibtool.config)
191+
* Copy a `bibtool.config` file to your document path, mine is located [here](https://github.com/comp-physics/group-docs/blob/master/templates/paper/bibtool.config)
192192
* Compile your document (I prefer `latexmk` for this, but a combination of `pdflatex` and `bibtex` also works).
193193
* Use the command `bibtool -r bibtool.config -x main.aux > test.bib`
194194
* Now you have a file `test.bib` that contains only the bibliography entries in your document
@@ -200,7 +200,7 @@ We generally want our references at the end of sentences unless they are part of
200200
* It does this on `test.bib` in the above call. You will want to do it on whatever the `bibtool` output file is.
201201

202202
* Bibliography style file (`.bst`)
203-
* Unless the journal or conference you submit to insists otherwise, use the style file [here](https://github.com/sbryngelson/group-docs/blob/master/templates/paper/bibsty.bst). This style file includes the relevant information you want your entries to include (like title), but ignores others (like month of publication). It also supports author-year citations (invoked via `\citet{}` as above).
203+
* Unless the journal or conference you submit to insists otherwise, use the style file [here](https://github.com/comp-physics/group-docs/blob/master/templates/paper/bibsty.bst). This style file includes the relevant information you want your entries to include (like title), but ignores others (like month of publication). It also supports author-year citations (invoked via `\citet{}` as above).
204204

205205
## Colors
206206

docs/group-syllabus/responding-to-reviewers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ When you create a response document, make sure to
5050

5151
There are examples in this repository, including
5252

53-
* A Revision template [in this directory](https://github.com/sbryngelson/group-docs/tree/master/templates/paper_rebuttal)
53+
* A Revision template [in this directory](https://github.com/comp-physics/group-docs/tree/master/templates/paper_rebuttal)
5454

5555
* In the same place, a `Makefile` that uses the `latexdiff` tool to create a `diff` between the submitted (`main.tex`) and revised (`main_rev.tex`) manuscript files in the form of a new PDF file called `diff.pdf`. This shows the reviewer explicitly all the changes you made to improve the paper (on top of the revisions in the response to the reviewers document).
5656

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Welcome! This is the documentation for the Computational Physics research group
2727
[Hardware](group-syllabus/hardware.md)
2828

2929
**Templates**
30-
[Papers](https://github.com/sbryngelson/group-docs/tree/master/templates/paper) ·
31-
[Paper reviews](https://github.com/sbryngelson/group-docs/tree/master/templates/paper_rebuttal) ·
32-
[Figures](https://github.com/sbryngelson/group-docs/tree/master/templates/paper/figures) ·
33-
[Talks](https://github.com/sbryngelson/group-docs/tree/master/templates/talks)
30+
[Papers](https://github.com/comp-physics/group-docs/tree/master/templates/paper) ·
31+
[Paper reviews](https://github.com/comp-physics/group-docs/tree/master/templates/paper_rebuttal) ·
32+
[Figures](https://github.com/comp-physics/group-docs/tree/master/templates/paper/figures) ·
33+
[Talks](https://github.com/comp-physics/group-docs/tree/master/templates/talks)
3434

3535
---
3636

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: "Computational Physics @ GT: Group Documentation"
2-
site_url: https://group-docs.readthedocs.io
3-
repo_url: https://github.com/sbryngelson/group-docs
2+
site_url: https://comp-physics.group/group-docs/
3+
repo_url: https://github.com/comp-physics/group-docs
44
edit_uri: edit/master/docs/
55
docs_dir: docs
66

readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Documentation for the Computational Physics research group at Georgia Tech.
44

5-
**[Read the docs here](https://github.com/sbryngelson/group-docs)**
5+
**[Read the docs here](https://comp-physics.group/group-docs/)**
66

77
## License
88

templates/.DS_Store

6 KB
Binary file not shown.

0 commit comments

Comments
 (0)