-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
create docs with github pages using material for mkdocs
- Loading branch information
xiaywang
committed
Jan 18, 2022
1 parent
24241aa
commit 4cdb679
Showing
3 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
name: ci # (1)! | ||
on: | ||
push: | ||
branches: | ||
- master # (2)! | ||
- 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 mkdocs-material # (3)! | ||
- run: mkdocs gh-deploy --force |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# PULP DSP | ||
|
||
The PULP DSP library implements functions for Digital Signal Processing (DSP) on [Parallel Ultra Low Power (PULP) platform](https://pulp-platform.org/). | ||
|
||
## Getting Started | ||
|
||
Please refer to `README.md`. | ||
|
||
## Documentation | ||
|
||
The documentation is built from the latest master and hosted at github pages: [https://pulp-platform.github.io/pulp-dsp](https://pulp-platform.github.io/pulp-dsp). | ||
|
||
## Licensing | ||
|
||
Snitch is being made available under permissive open source licenses. See the `README.md` for a more detailed break-down. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
site_name: PULP DSP | ||
theme: | ||
name: material | ||
|
||
icon: | ||
repo: fontawesome/brands/github | ||
|
||
repo_url: https://github.com/pulp-platform/pulp-dsp | ||
repo_name: pulp-platform/pulp-dsp | ||
|