Skip to content

Commit

Permalink
refactor site to use mkdocs sphinx-immaterial
Browse files Browse the repository at this point in the history
It looks SO GOOD

Signed-off-by: vsoch <[email protected]>
  • Loading branch information
vsoch committed Jan 13, 2023
1 parent dffde39 commit 0d9d2b5
Show file tree
Hide file tree
Showing 25 changed files with 1,863 additions and 95 deletions.
27 changes: 10 additions & 17 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,24 @@ jobs:
name: validate commits
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
fetch-depth: 0
- run: git fetch origin master
- uses: flux-framework/pr-validator@master
make-check:

spelling:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/checkout@v3
- name: install dependencies
run: >-
sudo apt-get update -y &&
sudo apt-get install -y enchant python3-pip &&
sudo apt-get install -y python3-pip &&
sudo pip3 install --upgrade -r ./requirements.txt
- name: make check
run: make check
make-linkcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: install dependencies
run: >-
sudo apt-get update -y &&
sudo apt-get install -y enchant python3-pip &&
sudo pip3 install --upgrade -r ./requirements.txt
- name: make linkcheck
run: make linkcheck
- name: Check Spelling
uses: crate-ci/typos@7ad296c72fa8265059cc03d1eda562fbdfcd6df2 # v1.9.0
with:
files: "*.rst"
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
_build
venv
env
__pycache__
11 changes: 2 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,9 @@ BUILDDIR = _build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile check spelling
.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

check: spelling

spelling:
@$(SPHINXBUILD) -W -b spelling "$(SOURCEDIR)" "$(BUILDDIR)" \
$(SPHINXOPTS) $(O) \
|| (cat $(BUILDDIR)/output.txt; exit 1)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
19 changes: 19 additions & 0 deletions _static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.o-tooltip--left:after{
font-size: 0.8rem;
}

.md-hero__inner {
padding: 0px !important;
}

/* Fix ugly mustard buttons! */
div.sphx-glr-download a {
background-color: #FFF;
background-image: linear-gradient(to bottom, #FFF, #FFF);
border: 1px solid #cccc;
}


div.sphx-glr-download a:hover {
background-color: gold !important;
}
Binary file added _static/images/favicon.ico
Binary file not shown.
Loading

0 comments on commit 0d9d2b5

Please sign in to comment.