-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: init docs setup with github workflow and main page
- Loading branch information
1 parent
9597d51
commit 86f3a17
Showing
14 changed files
with
595 additions
and
23 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
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,26 @@ | ||
name: 📖 Publish Docs | ||
|
||
on: | ||
push: | ||
paths: | ||
- docs/** | ||
- src/** | ||
- mkdocs.yml | ||
branches: [main] | ||
# Allow manual trigger (workflow_dispatch) | ||
workflow_dispatch: | ||
|
||
jobs: | ||
build_openapi_json: | ||
uses: hotosm/gh-workflows/.github/workflows/openapi_build.yml@1.6.0 | ||
with: | ||
image: ghcr.io/${{ github.repository }}/backend:ci-${{ github.ref_name }} | ||
example_env_file_path: ".env.sample" | ||
output_path: docs/openapi.json | ||
|
||
publish_docs: | ||
uses: hotosm/gh-workflows/.github/workflows/mkdocs_build.yml@1.6.0 | ||
needs: | ||
- build_openapi_json | ||
with: | ||
openapi: 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 @@ | ||
hotosm.github.io |
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,5 @@ | ||
:root { | ||
--md-primary-fg-color: #d73f3f; | ||
--md-primary-fg-color--light: #e27575; | ||
--md-primary-fg-color--dark: #c22929; | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,3 @@ | ||
# Drone Tasking Manager | ||
|
||
Welcome to the docs! |
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,68 @@ | ||
site_name: FMTM | ||
site_description: Community-driven drone imagery generation. | ||
# strict: true | ||
site_url: "https://hotosm.github.io/drone-tm/" | ||
|
||
repo_name: "hotosm/Drone-TM" | ||
repo_url: "https://github.com/hotosm/Drone-TM/" | ||
edit_uri: "edit/main/docs/" | ||
|
||
extra: | ||
social: | ||
- icon: "fontawesome/brands/github" | ||
link: "https://github.com/hotosm/" | ||
- icon: "fontawesome/brands/twitter" | ||
link: "https://twitter.com/hotosm" | ||
- icon: "fontawesome/solid/globe" | ||
link: "https://www.hotosm.org" | ||
copyright: Copyright © 2010 HOTOSM | ||
generator: false | ||
|
||
theme: | ||
name: material | ||
palette: | ||
primary: custom | ||
language: en | ||
favicon: images/favicon.png | ||
logo: images/hot_logo.png | ||
|
||
extra_css: | ||
- css/extra.css | ||
|
||
markdown_extensions: | ||
- tables | ||
- toc: | ||
permalink: true | ||
title: Page contents | ||
- admonition | ||
- pymdownx.details | ||
- pymdownx.superfences | ||
- pymdownx.highlight | ||
- pymdownx.extra | ||
- pymdownx.emoji: | ||
- pymdownx.tabbed: | ||
alternate_style: true | ||
- mdx_truly_sane_lists | ||
|
||
plugins: | ||
- search | ||
- git-revision-date-localized | ||
- exclude: | ||
glob: | ||
- plugins/* | ||
- __pycache__/* | ||
- mkdocstrings: | ||
handlers: | ||
python: | ||
paths: [.] | ||
options: | ||
members_order: source | ||
separate_signature: true | ||
filters: ["!^_"] | ||
docstring_options: | ||
ignore_init_summary: true | ||
merge_init_into_class: true | ||
|
||
nav: | ||
- Home: index.md | ||
- API Docs: https://hotosm.github.io/swagger/?url=https://hotosm.github.io/drone-tm/openapi.json |
Oops, something went wrong.