Skip to content

Commit

Permalink
Build and deploy documentation.
Browse files Browse the repository at this point in the history
This is very basic to start with.
  • Loading branch information
MrCurtis committed Jan 28, 2024
1 parent a08dde7 commit ee2cb56
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 1 deletion.
39 changes: 39 additions & 0 deletions .github/workflows/upload_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Upload docs artifact
on: [push]
jobs:
Create-Docs:
runs-on: ubuntu-latest
steps:
- name: Check out repository code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install .
pip install -r docs_requirements.txt
- name: Create docs
run: mkdocs build
- name: Upload as artifact
uses: actions/upload-pages-artifact@v3
with:
path: site

Upload-to-Pages:
if: github.ref == 'refs/heads/main'
needs: Create-Docs
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
9 changes: 9 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# FK-Graph

Visualise the graphs hidden within relational databases.

Schemas can sometimes fail to reflect the full complexity of the relationships in a
populated database, especially when the data has been added manually over a period of time.

This application creates a graph of foreign key relations in a populated database and
can be used to generate a plotly figure, or interactive dash app, showing these relations.
1 change: 1 addition & 0 deletions docs_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mkdocs==1.5.3
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site_name: FK-Graph Docs
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "hatchling.build"
[project]
name = "fk-graph"
packages = ["src/fk_graph"]
version = "0.0.9"
version = "0.0.10"
authors = [
{ name="Andrew Curtis", email="[email protected]" },
{ name="John C Thomas" },
Expand Down

0 comments on commit ee2cb56

Please sign in to comment.