Skip to content

Commit

Permalink
docs: init docs setup with github workflow and main page
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Jul 23, 2024
1 parent 9597d51 commit 86f3a17
Show file tree
Hide file tree
Showing 14 changed files with 595 additions and 23 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/build_and_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ name: Build and Deploy Drone Tasking Manager

on:
push:
branches:
- main
branches: [main]
workflow_dispatch:

permissions:
Expand Down
26 changes: 26 additions & 0 deletions .github/workflows/docs.yml
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/[email protected]
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/[email protected]
needs:
- build_openapi_json
with:
openapi: true
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
hotosm.github.io
5 changes: 5 additions & 0 deletions docs/css/extra.css
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;
}
1 change: 1 addition & 0 deletions docs/images/dev_roadmap_badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/docs_badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/hot_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/timeline_badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/user_roadmap_badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Drone Tasking Manager

Welcome to the docs!
68 changes: 68 additions & 0 deletions mkdocs.yml
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
Loading

0 comments on commit 86f3a17

Please sign in to comment.