Skip to content

Commit

Permalink
Added auto deploy docs github action and Fixed Documentation
Browse files Browse the repository at this point in the history
* actions: added gh-pages deploy workflow

* docs: Fix navigation tabs

* docs: simulations: Fix images

* actions: Use github-actions config
  • Loading branch information
yashlamba authored and sakshamarora1 committed Oct 30, 2020
1 parent 212dcda commit 667c0d5
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 11 deletions.
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:
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.7'
architecture: 'x64'
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install mkdocs
python3 -m pip install mkdocs-material
python3 -m pip install pymdown-extensions
python3 -m pip install mkdocs-git-revision-date-localized-plugin
- name: Git setup and update
run: |
git config user.name "GitHub Action" && git config user.email "[email protected]"
git fetch origin
- name: Build Docs
run: mkdocs build
- name: Add latest web build and deploy
run: |
git clone -b web https://github.com/cod-ed/simulate web
mv web/web/ site/
mkdocs gh-deploy --dirty
4 changes: 1 addition & 3 deletions docs/simulations/algorithms/ToothpickPattern.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Toothpick Pattern
---
<div style="float:right">
![ToothpickPatternLight](https://raw.githubusercontent.com/cod-ed/simulate/master/assets/simulations/ToothpickPatternLight.png)
</div>
![ToothpickPatternLight](https://raw.githubusercontent.com/cod-ed/simulate/master/assets/simulations/ToothpickPatternLight.png){: style="height:200px";: align=right}

<p align="justify">
The toothpick sequence in geometry is a 2D pattern sequence which is based on the previous
Expand Down
4 changes: 1 addition & 3 deletions docs/simulations/mathematics/LissajousPattern.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Lissajous Pattern
---
<div style="float:right">
![LissajousPatternLight](https://raw.githubusercontent.com/cod-ed/simulate/master/assets/simulations/LissajousCurveLight.png){: style="height:200px";}
</div>
![LissajousPatternLight](https://raw.githubusercontent.com/cod-ed/simulate/master/assets/simulations/LissajousCurveLight.png){: style="height:200px";: align=right}

<p align="justify">
A Lissajous curve in mathematics, also known as Lissajous Figure or Bowditch curve is the
Expand Down
4 changes: 1 addition & 3 deletions docs/simulations/mathematics/MaurerRosePattern.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Maurer Rose Pattern
---
<div style="float:right">
![MaurerRoseLight](https://raw.githubusercontent.com/cod-ed/simulate/master/assets/simulations/MaurerRoseLight.png){: style="height:200px";}
</div>
![MaurerRoseLight](https://raw.githubusercontent.com/cod-ed/simulate/master/assets/simulations/MaurerRoseLight.png){: style="height:200px";: align=right}

A Maurer rose of the rose $r = sin(nθ)$ consists of the 360 lines successively connecting the mentioned below
361 points, where $n$ is a positive integer. The rose has $n$ petals if $n$ is odd, and $2n$ petals if $n$ is even.
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ nav:
theme:
name: 'material'
features:
- tabs
- navigation.tabs
palette:
primary: 'black'
accent: 'white'
Expand All @@ -34,7 +34,7 @@ theme:
code: 'Ubuntu Mono'
icon:
logo: material/atom
repo: octicons/mark-github
repo: octicons/mark-github-16

# Customization

Expand Down

0 comments on commit 667c0d5

Please sign in to comment.