Skip to content

Commit

Permalink
Refresh docs (#97)
Browse files Browse the repository at this point in the history
This adds updated and documentation that better reflects how superglue
works today. There's still some work to do, but this sets up so the docs
are more easily deployable.
  • Loading branch information
jho406 authored Oct 8, 2024
1 parent e4df3e2 commit c9749a6
Show file tree
Hide file tree
Showing 42 changed files with 3,297 additions and 1,950 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Publish docs
on:
push:
branches:
- main
permissions:
contents: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18

- name: npm install
working-directory: ./superglue
run: npm install

- name: Build typedoc
working-directory: ./superglue
run: npx typedoc

- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: pip install mkdocs-material
- name: Build mkdoc
run: mkdocs build --site-dir ./_site
- name: Upload artifact
uses: actions/upload-pages-artifact@v3

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
126 changes: 0 additions & 126 deletions docs/README.md

This file was deleted.

35 changes: 0 additions & 35 deletions docs/_sidebar.md

This file was deleted.

96 changes: 0 additions & 96 deletions docs/concepts.md

This file was deleted.

Loading

0 comments on commit c9749a6

Please sign in to comment.