Skip to content

Commit 56f7310

Browse files
committed
Migrating documentation to mkdoc
Create the documentation pages using mkdoc with material theme
1 parent 13edca2 commit 56f7310

Some content is hidden

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

49 files changed

+475
-1003
lines changed

.github/workflows/build-docs.yaml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Build Documentation
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- main
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Configure Git Credentials
15+
run: |
16+
git config user.name github-actions[bot]
17+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
18+
- uses: actions/setup-python@v5
19+
with:
20+
python-version: 3.x
21+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
22+
- uses: actions/cache@v4
23+
with:
24+
key: mkdocs-material-${{ env.cache_id }}
25+
path: .cache
26+
restore-keys: |
27+
mkdocs-material-
28+
- run: pip install mkdocs-material
29+
- run: mkdocs gh-deploy --force

docs/Makefile

-178
This file was deleted.
-512 KB
Binary file not shown.

docs/_static/images/rh2_animation.gif

-404 KB
Binary file not shown.
-404 KB
Binary file not shown.
-291 KB
Binary file not shown.

docs/_static/variable_list.csv

-37
This file was deleted.

docs/animation.rst

-36
This file was deleted.

docs/authors.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### Development Lead
2+
J Sundar <wrf.guy@gmail.com>
3+
4+
### Developers
5+
None yet. Why not be the first?
6+
7+
### Other contributors
8+
9+
Those who have given their feedback and reported bugs can be found in [https://github.com/wxguy/wrfplot/issues](https://github.com/wxguy/wrfplot/issues).

docs/authors.rst

-4
This file was deleted.

docs/cmap.rst

-33
This file was deleted.

docs/colormaps.md

+34
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)