Skip to content

Commit 2165afd

Browse files
committed
Add doc
1 parent e8454a4 commit 2165afd

5 files changed

Lines changed: 44 additions & 0 deletions

File tree

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Documentation
2+
on:
3+
push:
4+
branches:
5+
- master
6+
tags: '*'
7+
pull_request:
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
- uses: julia-actions/setup-julia@latest
14+
with:
15+
version: '1.5'
16+
- name: Install dependencies
17+
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
18+
- name: Build and deploy
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
21+
run: julia --project=docs/ docs/make.jl

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/build/

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
11
# PostgresORM.jl
22

33
An Julia library for Object Relational Mapping between Julia and PostgreSQL.
4+
5+
**Documentation**: [![][docs-stable-img]][docs-stable-url]
6+
7+
[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
8+
[docs-latest-url]: http://dataframes.juliadata.org/latest/
9+
10+
11+
**NOTES about this documentation**
12+
The documentation is created using
13+
[https://github.com/JuliaDocs/Documenter.jl](Documenter.jl).
14+
see [docs](./docs).
15+
16+
https://juliadocs.github.io/Documenter.jl/stable/man/guide/

docs/make.jl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
using Documenter, PostgresORM
2+
3+
makedocs(sitename="PostgresORM documentation",
4+
modules = [PostgresORM],
5+
pages=[
6+
"Home" => "index.md"
7+
])
8+
deploydocs(;repo="github.com/JuliaPostgresORM/PostgresORM.jl",)

docs/src/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Hello world

0 commit comments

Comments
 (0)