Skip to content

Commit 546c7b2

Browse files
authored
Updated ConvoKit Website (#335)
Co-authored-by: ex36 <96800594+Torchee@users.noreply.github.com>
1 parent 10cd835 commit 546c7b2

16 files changed

Lines changed: 3029 additions & 180 deletions

File tree

.github/workflows/website.yml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,19 @@ jobs:
1010
runs-on: ubuntu-latest
1111
steps:
1212
- uses: actions/checkout@v3
13-
- name: Install nanosite
13+
- name: Install Dependencies
1414
run: |
15-
python -m pip install --upgrade pip
16-
python -m pip install nanosite
17-
- name: Nanosite build
18-
working-directory: ./website
19-
run: |
20-
tail -n +2 ../README.md > index.md+
21-
nanosite build
15+
pip install sphinx sphinx-rtd-theme m2r2
16+
- name: Sphinx Build
17+
uses: ammaraskar/sphinx-action@master
18+
with:
19+
docs-folder: "website/"
20+
build-command: "sphinx-build -b html ./source ./build"
2221
- name: rsync homepage files
2322
uses: burnett01/rsync-deployments@master
2423
with:
2524
switches: -vzr
26-
path: ./website/output/
25+
path: website/build/
2726
remote_path: ${{ secrets.DEPLOY_WEBSITE_PATH }}
2827
remote_host: ${{ secrets.DEPLOY_HOST }}
2928
remote_user: ${{ secrets.DEPLOY_USER }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,4 @@ venv-triadmotif/
3939
*.tsv
4040
!/docs/source/img/*
4141
env/
42+
website/docs/build

website/.nanosite

Lines changed: 0 additions & 1 deletion
This file was deleted.

website/docs/Makefile

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# docs/Makefile
2+
# Minimal makefile for Sphinx documentation
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21+
22+
# Custom targets
23+
clean:
24+
rm -rf $(BUILDDIR)/*
25+
26+
livehtml:
27+
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
28+
29+
github:
30+
@echo "Building for GitHub Pages..."
31+
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
32+
@touch $(BUILDDIR)/html/.nojekyll
33+
@echo "Build complete. Deploy the $(BUILDDIR)/html directory to GitHub Pages."

0 commit comments

Comments
 (0)