Skip to content

Commit

Permalink
restructure docs tooling files
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippMolitor committed Dec 23, 2024
1 parent cd3a985 commit 0c14bf9
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cd-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:

- name: Build MkDocs Pages
working-directory: docs/
run: uv run mkdocs build -f _kalico/mkdocs.yml
run: uv run mkdocs build

- name: Deploy
uses: JamesIves/[email protected]
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci-docs_test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ jobs:

- name: Build MkDocs Pages
working-directory: docs/
run: uv run mkdocs build -f _kalico/mkdocs.yml --strict
run: uv run mkdocs build --strict
10 changes: 7 additions & 3 deletions docs/_kalico/README → docs/README
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ https://www.mkdocs.org/ ) to automatically convert the markdown files
in the docs/ directory to html. In addition to the files in this
directory, the docs/CNAME file also controls the website generation.

To test deploy the main English site locally one can use commands
To test deploy the main site locally one can use commands
similar to the following:

virtualenv ~/mkdocs-env && ~/python-env/bin/pip install -r ~/kalico/docs/_kalico/mkdocs-requirements.txt
cd ~/kalico && ~/mkdocs-env/bin/mkdocs serve --config-file ~/kalico/docs/_kalico/mkdocs.yml -a 0.0.0.0:8000
```bash
cd docs/ # if you were in the repo root
uv venv
uv sync
uv run mkdocs serve
```
8 changes: 4 additions & 4 deletions docs/_kalico/mkdocs.yml → docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ repo_url: https://github.com/KalicoCrew/kalico/
repo_name: KalicoCrew/kalico
edit_uri: edit/main/docs/src/
use_directory_urls: False
docs_dir: '../src'
site_dir: '../../site/'
docs_dir: 'src/'
site_dir: '../site/'

validation:
omitted_files: warn
Expand All @@ -30,7 +30,7 @@ plugins:
lang: en
mkdocs-simple-hooks:
hooks:
on_page_markdown: "docs._kalico.mkdocs_hooks:transform"
on_page_markdown: "docs.mkdocs_hooks:transform"

# Website layout configuration (using mkdocs-material theme)
theme:
Expand Down Expand Up @@ -69,7 +69,7 @@ theme:
name: Switch to light mode

extra_css:
- _kalico/css/extra.css
- css/kalico.css

extra:
social:
Expand Down
File renamed without changes.
File renamed without changes.

0 comments on commit 0c14bf9

Please sign in to comment.