-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Thomas Carmet <[email protected]>
- Loading branch information
1 parent
3954f11
commit 4f8561e
Showing
8 changed files
with
106 additions
and
9 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 |
---|---|---|
|
@@ -6,3 +6,4 @@ tests | |
.trunk | ||
.venv | ||
.hypothesis | ||
site |
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,24 @@ | ||
--- | ||
name: build documentation | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Install Poetry | ||
run: | | ||
pipx install poetry | ||
- uses: actions/setup-python@v4 | ||
with: | ||
python-version: 3.x | ||
cache: poetry | ||
- name: Install Dependencies | ||
run: | | ||
poetry install --only docs | ||
- run: poetry run mkdocs build --strict |
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 |
---|---|---|
|
@@ -2,3 +2,4 @@ __pycache__ | |
.venv | ||
.pytest_cache | ||
.hypothesis | ||
site |
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,65 @@ | ||
site_name: Runner Manager | ||
repo_url: https://github.com/scality/runner-manager | ||
repo_name: scality/runner-manager | ||
edit_uri: edit/main/docs/ | ||
theme: | ||
icon: | ||
repo: fontawesome/brands/github | ||
name: material | ||
include_search_page: false | ||
search_index_only: true | ||
language: en | ||
features: | ||
- navigation.indexes | ||
- navigation.instant | ||
- navigation.sections | ||
- navigation.expand | ||
- navigation.tabs | ||
- navigation.tabs.sticky | ||
- search.highlight | ||
- search.share | ||
- search.suggest | ||
- toc.follow | ||
- header.autohide | ||
palette: | ||
# Palette toggle for light mode | ||
- scheme: default | ||
toggle: | ||
icon: material/brightness-7 | ||
name: Switch to dark mode | ||
|
||
# Palette toggle for dark mode | ||
- scheme: slate | ||
toggle: | ||
icon: material/brightness-4 | ||
name: Switch to light mode | ||
font: | ||
text: Roboto | ||
code: Roboto Mono | ||
|
||
nav: | ||
- Home: index.md | ||
- Development: | ||
- development/index.md | ||
- Code: development/code.md | ||
- Concepts: development/concepts.md | ||
- Configuration: development/configuration.md | ||
- Environment: development/environment.md | ||
- Testing: development/testing.md | ||
- Workflows: development/workflows.md | ||
|
||
markdown_extensions: | ||
- pymdownx.highlight: | ||
anchor_linenums: true | ||
- pymdownx.emoji: | ||
emoji_index: !!python/name:materialx.emoji.twemoji | ||
emoji_generator: !!python/name:materialx.emoji.to_svg | ||
- pymdownx.inlinehilite | ||
- pymdownx.snippets | ||
- pymdownx.superfences | ||
- tables | ||
- attr_list | ||
- md_in_html | ||
- meta | ||
- admonition | ||
- pymdownx.details |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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