-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b89a926
commit 4e37f61
Showing
8 changed files
with
297 additions
and
174 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,34 @@ | ||
name: Publish docs via GitHub Pages | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
# Only rebuild website when docs have changed | ||
- 'README.md' | ||
- 'CHANGELOG.md' | ||
- 'CONTRIBUTING.md' | ||
- 'docs/**' | ||
|
||
jobs: | ||
build: | ||
name: Deploy docs | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout main | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Python 3.8 | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.8 | ||
|
||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
python -m pip install numpy | ||
python -m pip install .["docs"] | ||
- name: Deploy docs | ||
run: mkdocs gh-deploy --force -f docs/mkdocs.yml |
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
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,74 @@ | ||
# Project Information | ||
site_name: 'geojson-pydantic' | ||
site_description: 'Pydantic models for GeoJSON' | ||
|
||
docs_dir: 'src' | ||
site_dir: 'build' | ||
|
||
# Repository | ||
repo_name: 'developmentseed/geojson-pydantic' | ||
repo_url: 'https://github.com/developmentseed/geojson-pydantic' | ||
edit_uri: 'blob/main/src/' | ||
site_url: 'https://developmentseed.org/geojson-pydantic/' | ||
|
||
# Social links | ||
extra: | ||
social: | ||
- icon: 'fontawesome/brands/github' | ||
link: 'https://github.com/developmentseed' | ||
- icon: 'fontawesome/brands/twitter' | ||
link: 'https://twitter.com/developmentseed' | ||
|
||
# Layout | ||
nav: | ||
- Home: 'index.md' | ||
- Usage: 'usage.md' | ||
- Development - Contributing: 'contributing.md' | ||
- Release: 'release-notes.md' | ||
|
||
# Theme | ||
theme: | ||
icon: | ||
logo: 'material/home' | ||
repo: 'fontawesome/brands/github' | ||
name: 'material' | ||
language: 'en' | ||
palette: | ||
primary: 'pink' | ||
accent: 'light pink' | ||
font: | ||
text: 'Nunito Sans' | ||
code: 'Fira Code' | ||
|
||
plugins: | ||
- search | ||
|
||
# These extensions are chosen to be a superset of Pandoc's Markdown. | ||
# This way, I can write in Pandoc's Markdown and have it be supported here. | ||
# https://pandoc.org/MANUAL.html | ||
markdown_extensions: | ||
- admonition | ||
- attr_list | ||
- codehilite: | ||
guess_lang: false | ||
- def_list | ||
- footnotes | ||
- pymdownx.arithmatex | ||
- pymdownx.betterem | ||
- pymdownx.caret: | ||
insert: false | ||
- pymdownx.details | ||
- pymdownx.emoji | ||
- pymdownx.escapeall: | ||
hardbreak: true | ||
nbsp: true | ||
- pymdownx.magiclink: | ||
hide_protocol: true | ||
repo_url_shortener: true | ||
- pymdownx.smartsymbols | ||
- pymdownx.superfences | ||
- pymdownx.tasklist: | ||
custom_checkbox: true | ||
- pymdownx.tilde | ||
- toc: | ||
permalink: true |
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 @@ | ||
../../CONTRIBUTING.md |
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 @@ | ||
../../README.md |
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 @@ | ||
../../CHANGELOG.md |
Oops, something went wrong.