Skip to content

Commit

Permalink
docs(build): move away from readthedocs and switch to automatic githu…
Browse files Browse the repository at this point in the history
…b pages
  • Loading branch information
ultrabug committed Oct 13, 2023
1 parent bbc6019 commit 633b34b
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 24 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Deploy docs

on:
push:
branches:
- master

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Download source
uses: actions/checkout@v3
- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install Python dependencies
run: |
python -m pip install --upgrade hatch
- name: Build site
run: hatch -e docs run mkdocs build
- name: Deploy to gh-pages
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
uses: oprypin/push-to-gh-pages@v3
with:
publish_dir: site
commit_message: 'Generate docs: '
15 changes: 0 additions & 15 deletions .readthedocs.yaml

This file was deleted.

Binary file added docs/assets/logomark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 10 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,20 @@ site_url: https://ultrabug.github.io/py3status
repo_url: https://github.com/ultrabug/py3status

theme:
name: readthedocs
name: material
font:
text: Ubuntu
code: Ubuntu Mono
icon:
logo: material/file-document-multiple
logo: assets/logomark.png
palette:
primary: blue
primary: black
features:
- navigation.expand
- navigation.indexes
- navigation.sections
- navigation.tabs
- toc.follow
- toc.integrate

extra:
social:
Expand Down
9 changes: 8 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,11 @@ line_length = 100

[tool.ruff]
line-length = 100
ignore = ["E501"]
ignore = ["E501"]

[tool.hatch.envs.docs]
dependencies = [
"mkdocs-material>=9.4.5",
"Pillow>=3.4.2",
"fonttools==4.24.4",
]
4 changes: 0 additions & 4 deletions requirements/documentation.txt

This file was deleted.

0 comments on commit 633b34b

Please sign in to comment.