mirror of
https://gitea.invidious.io/iv-org/shard-athena-negotiation.git
synced 2024-08-15 00:53:23 +00:00
Finish porting docs to mkdocs (#4)
This commit is contained in:
parent
4c2e6b96ef
commit
9e2579d622
3 changed files with 4 additions and 30 deletions
27
.github/workflows/deployment.yml
vendored
27
.github/workflows/deployment.yml
vendored
|
@ -1,27 +0,0 @@
|
|||
name: Deployment
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
deploy_docs:
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: crystallang/crystal:latest-alpine
|
||||
steps:
|
||||
- name: Install Build Dependencies
|
||||
run: apk add --update rsync
|
||||
- uses: actions/checkout@v2
|
||||
- name: Install Dependencies
|
||||
run: shards install
|
||||
- name: Build
|
||||
run: crystal docs lib/athena-spec/src/athena-spec.cr src/athena-negotiation.cr
|
||||
- name: Deploy
|
||||
uses: JamesIves/github-pages-deploy-action@3.7.1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
BRANCH: gh-pages
|
||||
FOLDER: docs
|
||||
SINGLE_COMMIT: true
|
|
@ -20,7 +20,8 @@ dependencies:
|
|||
|
||||
## Documentation
|
||||
|
||||
Everything is documented in the [API Docs](https://athena-framework.github.io/negotiation/Athena/Negotiation.html).
|
||||
If using the component on its own, checkout the [API documentation](https://athenaframework.org/Negotiation).
|
||||
If using the component as part of Athena, also checkout the [external documentation](https://athenaframework.org/components/negotiation).
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
name: athena-negotiation
|
||||
|
||||
version: 0.1.0
|
||||
version: 0.1.1
|
||||
|
||||
crystal: '>= 0.35.0'
|
||||
|
||||
|
@ -8,7 +8,7 @@ license: MIT
|
|||
|
||||
repository: https://github.com/athena-framework/negotiation
|
||||
|
||||
documentation: https://athena-framework.github.io/negotiation/Athena/Negotiation.html
|
||||
documentation: https://athenaframework.org/Negotiation
|
||||
|
||||
description: |
|
||||
Framework agnostic content negotiation library.
|
||||
|
|
Loading…
Reference in a new issue