Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
* develop:
  feat: add documentation website (#37)
  improv: move away from monorepo due to change in direction (#36)
  fix: #35 duplicate changelog to project root
  • Loading branch information
heitorlessa committed May 27, 2020
2 parents b9f2bc1 + e51dd10 commit 07f2b31
Show file tree
Hide file tree
Showing 80 changed files with 22,043 additions and 988 deletions.
File renamed without changes.
9 changes: 1 addition & 8 deletions .github/workflows/python.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
name: Powertools Python
name: Build

on:
pull_request:
branches:
- develop
- master
paths:
- "python/**"
push:
branches:
- develop
- master
paths:
- "python/**"

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./python/
strategy:
max-parallel: 4
matrix:
Expand Down
19 changes: 5 additions & 14 deletions .github/workflows/python_docs.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,26 @@
name: Powertools Python Docs
name: Docs

on:
pull_request:
branches:
- master
paths:
- "python/**"
push:
branches:
- master
paths:
- "python/**"

jobs:
docs:
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./python/
steps:
- uses: actions/checkout@v1
- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: "3.8"
- name: Install dependencies
run: make dev
- name: build docs
run: make docs
- name: deploy docs
- name: Build docs website
run: make build-docs
- name: Deploy docs
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: python/docs/aws_lambda_powertools/
publish_dir: ./dist
11 changes: 9 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -291,5 +291,12 @@ $RECYCLE.BIN/
# End of https://www.gitignore.io/api/osx,linux,python,windows,pycharm,visualstudiocode

# Misc
test_report
/.idea/*
test_report
wheelhouse
/.idea/*
*.html

# Docs files
docs/.cache/
docs/public
node_modules
File renamed without changes.
File renamed without changes.
21 changes: 19 additions & 2 deletions python/Makefile → Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ dev:
pip install --upgrade pip poetry
poetry install

dev-docs:
cd docs && npm install

format:
poetry run isort -rc .
poetry run black aws_lambda_powertools
Expand All @@ -25,10 +28,24 @@ pr: lint test security-baseline complexity-baseline
build: pr
poetry run build

docs: dev
poetry run pdoc --html --output-dir docs ./aws_lambda_powertools --force
build-docs:
mkdir -p dist/api
@$(MAKE) build-docs-website
@$(MAKE) build-docs-api

build-docs-api: dev
poetry run pdoc --html --output-dir dist/api/ ./aws_lambda_powertools --force
mv dist/api/aws_lambda_powertools/* dist/api/
rm -rf dist/api/aws_lambda_powertools

build-docs-website: dev-docs
cd docs && npm run build
cp -R docs/public/* dist/

docs-dev:
cd docs && npm run start

docs-api-dev:
poetry run pdoc --http : aws_lambda_powertools

security-baseline:
Expand Down
Loading

0 comments on commit 07f2b31

Please sign in to comment.