Skip to content

Commit 9db8e7f

Browse files
FEATURE : init mkdocs website + CD
1 parent 82d3875 commit 9db8e7f

File tree

8 files changed

+356
-0
lines changed

8 files changed

+356
-0
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @jeremy-picosson-tech
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Build & Deploy Github Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
jobs:
15+
16+
build-docs:
17+
18+
name: python
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- uses: actions/checkout@v4
23+
24+
- name: Install uv
25+
uses: astral-sh/setup-uv@v5
26+
27+
- name: Install the project
28+
run: uv sync --locked --all-extras --dev
29+
30+
- name: build docs
31+
# For example, using `pytest`
32+
run: cd MyWebSite & uv run mkdocs build
33+
34+
- name: Upload artifact for Pages
35+
uses: actions/upload-pages-artifact@v3
36+
with:
37+
path: MyWebSite/site
38+
39+
40+
deploy:
41+
42+
if: github.ref == 'refs/heads/main'
43+
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
48+
concurrency:
49+
group: "pages"
50+
cancel-in-progress: false
51+
52+
runs-on: ubuntu-latest
53+
timeout-minutes: 30
54+
55+
needs:
56+
- build-docs
57+
58+
steps:
59+
- name: Setup Pages
60+
id: pages
61+
uses: actions/configure-pages@v5
62+
- name: Deploy to GitHub Pages
63+
id: deployment
64+
uses: actions/deploy-pages@v4

.python-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.12

MyWebSite/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
site/*

MyWebSite/docs/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Welcome to MkDocs
2+
3+
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
4+
5+
## Commands
6+
7+
* `mkdocs new [dir-name]` - Create a new project.
8+
* `mkdocs serve` - Start the live-reloading docs server.
9+
* `mkdocs build` - Build the documentation site.
10+
* `mkdocs -h` - Print help message and exit.
11+
12+
## Project layout
13+
14+
mkdocs.yml # The configuration file.
15+
docs/
16+
index.md # The documentation homepage.
17+
... # Other markdown pages, images and other files.

MyWebSite/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
site_name: My Docs

pyproject.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[project]
2+
name = "jeremy-picosson-github-io"
3+
version = "0.1.0"
4+
description = "Add your description here"
5+
readme = "README.md"
6+
requires-python = ">=3.12"
7+
dependencies = [
8+
"mkdocs>=1.6.1",
9+
]

uv.lock

Lines changed: 262 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)