Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small documentation update #204

Merged
merged 3 commits into from
Oct 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: docs
on:
push:
pull_request:

jobs:

build:
runs-on: ubuntu-latest
steps:
- uses: actions/setup-python@v4
with:
python-version: '3.11'
- uses: actions/checkout@v3
- run: python -m pip install .[docs]
- run: python -m sphinx -W -b html docs/ build/html/
- uses: actions/upload-pages-artifact@v1
with:
path: build/html

deploy:
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/master'
steps:
- uses: actions/deploy-pages@v1
133 changes: 0 additions & 133 deletions NOTES.md

This file was deleted.

9 changes: 0 additions & 9 deletions README.md

This file was deleted.

7 changes: 7 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
beanquery: Customizable lightweight SQL query tool
==================================================

beanquery is a customizable and extensible lightweight SQL query tool
that works on tabular data, including `Beancount`__ ledger data.

__ https://beancount.github.io/
Loading
Loading