Skip to content

Commit

Permalink
Merge pull request #3 from gabrielguarisa/f/docs-gh-action
Browse files Browse the repository at this point in the history
Update theme and add mkdocs-material plugin
  • Loading branch information
gabrielguarisa authored Nov 12, 2023
2 parents c99da61 + 438202c commit 878cff1
Show file tree
Hide file tree
Showing 5 changed files with 226 additions and 2 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: docs
on:
push:
branches:
- main

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- run: |
pip install lazydocs mkdocs mkdocs-awesome-pages-plugin mkdocs-material
- run: ./build-docs.sh
- run: mkdocs gh-deploy --force
7 changes: 7 additions & 0 deletions build-docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
lazydocs \
--output-path="./docs/" \
--overview-file="README.md" \
--src-base-url="https://github.com/gabrielguarisa/brdata/blob/main/" \
brdata

mkdocs build
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ plugins:
- search

theme:
name: readthedocs
name: material
Loading

0 comments on commit 878cff1

Please sign in to comment.