Skip to content

Commit 7e784a2

Browse files
amacatiamacati
committed
Add skeleton docs. Towards #10 
1 parent 082a149 commit 7e784a2

10 files changed

Lines changed: 1022 additions & 63 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v4
25+
26+
- name: Setup pixi
27+
uses: prefix-dev/setup-pixi@v0.8.1
28+
with:
29+
pixi-version: v0.49.0
30+
cache: true
31+
32+
- name: Build documentation
33+
run: pixi run -e docs mkdocs build
34+
35+
- name: Setup Pages
36+
uses: actions/configure-pages@v3
37+
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v4
40+
with:
41+
path: ./site
42+
43+
deploy:
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
runs-on: ubuntu-latest
48+
needs: build
49+
if: github.ref == 'refs/heads/main'
50+
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,9 @@ benchmark/data
2020
# pixi environments
2121
.pixi
2222
*.egg-info
23+
24+
# MkDocs build output
25+
site/
26+
# Temporary files
27+
.DS_Store
28+
Thumbs.db

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Fast, parallelizable simulations of Crazyflies with JAX.
66

77
[![Python Version]][Python Version URL] [![Ruff Check]][Ruff Check URL] [![Documentation Status]][Documentation Status URL] [![Tests]][Tests URL]
88

9-
[Python Version]: https://img.shields.io/badge/python-3.10+-blue.svg
9+
[Python Version]: https://img.shields.io/badge/python-3.11+-blue.svg
1010
[Python Version URL]: https://www.python.org
1111

1212
[Ruff Check]: https://github.com/utiasDSL/crazyflow/actions/workflows/ruff.yml/badge.svg?style=flat-square
1313
[Ruff Check URL]: https://github.com/utiasDSL/crazyflow/actions/workflows/ruff.yml
1414

15-
[Documentation Status]: https://readthedocs.org/projects/crazyflow/badge/?version=latest
16-
[Documentation Status URL]: https://crazyflow.readthedocs.io/en/latest/?badge=latest
15+
[Documentation Status]: https://github.com/utiasDSL/crazyflow/actions/workflows/docs.yml/badge.svg
16+
[Documentation Status URL]: https://utiasdsl.github.io/crazyflow
1717

1818
[Tests]: https://github.com/utiasDSL/crazyflow/actions/workflows/testing.yml/badge.svg
1919
[Tests URL]: https://github.com/utiasDSL/crazyflow/actions/workflows/testing.yml

‎docs/img/architecture.png‎

-201 KB
Binary file not shown.

‎docs/index.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Crazyflow
2+
3+
<div align="center">
4+
<img src="img/logo.png" alt="CrazyFlow Logo" width="400"/>
5+
</div>
6+
7+
## Welcome
8+
9+
Welcome to the Crazyflow documentation.
10+
11+
## Quick Links
12+
13+
- [GitHub Repository](https://github.com/utiasDSL/crazyflow)
14+
- [Installation Guide](#)
15+
- [Getting Started](#)
16+
- [API Reference](#)
17+
18+
## About
19+
20+
CrazyFlow is a fast, parallelizable simulation framework for Crazyflies built with JAX.

‎docs/mkdocs.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
site_name: CrazyFlow Documentation
2+
site_description: Fast, parallelizable simulations of Crazyflies with JAX and MuJoCo
3+
site_url: https://utiasdsl.github.io/crazyflow/
4+
repo_name: utiasDSL/crazyflow
5+
repo_url: https://github.com/utiasDSL/crazyflow
6+
7+
docs_dir: .
8+
9+
theme:
10+
name: material
11+
logo: img/logo.png
12+
favicon: img/logo.png
13+
features:
14+
- navigation.tabs
15+
- navigation.sections
16+
- navigation.expand
17+
- navigation.top
18+
- search.highlight
19+
- search.share
20+
- content.code.copy
21+
- content.code.annotate
22+
palette:
23+
- media: "(prefers-color-scheme: light)"
24+
scheme: default
25+
primary: blue
26+
accent: light blue
27+
toggle:
28+
icon: material/weather-sunny
29+
name: Switch to dark mode
30+
- media: "(prefers-color-scheme: dark)"
31+
scheme: slate
32+
primary: blue
33+
accent: light blue
34+
toggle:
35+
icon: material/weather-night
36+
name: Switch to light mode
37+
38+
nav:
39+
- Home: index.md
40+
41+
plugins:
42+
- search
43+
- autorefs
44+
- mkdocstrings:
45+
handlers:
46+
python:
47+
paths: [../crazyflow]
48+
options:
49+
docstring_style: google
50+
show_source: true
51+
show_root_heading: true
52+
show_category_heading: true
53+
merge_init_into_class: true
54+
55+
markdown_extensions:
56+
- admonition
57+
- pymdownx.details
58+
- pymdownx.superfences:
59+
custom_fences:
60+
- name: mermaid
61+
class: mermaid
62+
format: !!python/name:pymdownx.superfences.fence_code_format
63+
- pymdownx.highlight:
64+
anchor_linenums: true
65+
line_spans: __span
66+
pygments_lang_class: true
67+
- pymdownx.inlinehilite
68+
- pymdownx.snippets
69+
- pymdownx.tabbed:
70+
alternate_style: true
71+
- attr_list
72+
- md_in_html
73+
- tables
74+
- footnotes
75+
- def_list
76+
77+
extra:
78+
social:
79+
- icon: fontawesome/brands/github
80+
link: https://github.com/utiasDSL/crazyflow

‎docs/stylesheets/extra.css‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/* Custom color scheme for Drone Models */
2+
:root {
3+
--md-primary-fg-color: #2a3f84;
4+
--md-primary-fg-color--light: #3bd5f5;
5+
--md-primary-fg-color--dark: #2a3f84;
6+
--md-accent-fg-color: #2a3f84;
7+
--md-accent-fg-color--transparent: rgba(122, 181, 29, 0.1);
8+
}
9+
10+
/* Dark mode custom colors */
11+
[data-md-color-scheme="slate"] {
12+
--md-primary-fg-color: #5d69e7;
13+
--md-primary-fg-color--light: #3bd5f5;
14+
--md-primary-fg-color--dark: #2a3f84;
15+
--md-accent-fg-color: #2a3f84;
16+
--md-accent-fg-color--transparent: rgba(122, 181, 29, 0.1);
17+
}
18+
19+
/* Make the navigation logo larger */
20+
.md-header__button.md-logo {
21+
padding: 0;
22+
}
23+
24+
.md-header__button.md-logo img,
25+
.md-header__button.md-logo svg {
26+
height: 2rem;
27+
width: auto;
28+
}

‎mkdocs.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
site_name: Crazyflow Documentation
2+
site_description: Fast, parallelizable simulations of Crazyflies in JAX
3+
site_url: https://utiasdsl.github.io/crazyflow/
4+
repo_name: utiasDSL/crazyflow
5+
repo_url: https://github.com/utiasDSL/crazyflow
6+
7+
theme:
8+
name: material
9+
logo: img/logo.png
10+
features:
11+
- navigation.tabs
12+
- navigation.sections
13+
- navigation.expand
14+
- navigation.top
15+
- search.highlight
16+
- search.share
17+
- content.code.copy
18+
- content.code.annotate
19+
palette:
20+
- media: "(prefers-color-scheme: light)"
21+
scheme: default
22+
primary: blue
23+
accent: light blue
24+
toggle:
25+
icon: material/weather-sunny
26+
name: Switch to dark mode
27+
- media: "(prefers-color-scheme: dark)"
28+
scheme: slate
29+
primary: blue
30+
accent: light blue
31+
toggle:
32+
icon: material/weather-night
33+
name: Switch to light mode
34+
35+
nav:
36+
- Home: index.md
37+
38+
plugins:
39+
- search
40+
- autorefs
41+
- mkdocstrings:
42+
handlers:
43+
python:
44+
paths: [../crazyflow]
45+
options:
46+
docstring_style: google
47+
show_source: true
48+
show_root_heading: true
49+
show_category_heading: true
50+
merge_init_into_class: true
51+
52+
markdown_extensions:
53+
- admonition
54+
- pymdownx.details
55+
- pymdownx.superfences:
56+
custom_fences:
57+
- name: mermaid
58+
class: mermaid
59+
format: !!python/name:pymdownx.superfences.fence_code_format
60+
- pymdownx.highlight:
61+
anchor_linenums: true
62+
line_spans: __span
63+
pygments_lang_class: true
64+
- pymdownx.inlinehilite
65+
- pymdownx.snippets
66+
- pymdownx.tabbed:
67+
alternate_style: true
68+
- attr_list
69+
- md_in_html
70+
- tables
71+
- footnotes
72+
- def_list
73+
74+
extra:
75+
social:
76+
- icon: fontawesome/brands/github
77+
link: https://github.com/utiasDSL/crazyflow
78+
79+
extra_css:
80+
- stylesheets/extra.css

0 commit comments

Comments
 (0)