Skip to content

Commit

Permalink
Update ci
Browse files Browse the repository at this point in the history
  • Loading branch information
daxartio committed Mar 26, 2024
1 parent e998be8 commit d743495
Show file tree
Hide file tree
Showing 8 changed files with 447 additions and 26 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Github pages

on:
push:
branches: [ master ]
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- uses: actions/setup-python@v4
with:
python-version: '3.12'

- name: Install python dependencies
run: make install-poetry install

- name: Build
run: make docs
10 changes: 0 additions & 10 deletions .travis.yml

This file was deleted.

22 changes: 22 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
DEFAULT_GOAL := help

.PHONY: help
help:
@echo "Usage: make [target]"
@echo ""
@echo "Targets:"
@echo " install-poetry Install poetry"
@echo " install Install dependencies"
@echo " docs Build documentation"

.PHONY: install-poetry
install-poetry:
pip install poetry

.PHONY: install
install:
poetry install --no-root

.PHONY: docs
docs:
poetry run mkdocs build
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
[![Build Status](https://api.travis-ci.org/sportorg/sportorg-docs.svg?branch=master)](https://travis-ci.org/sportorg/sportorg-docs)
# Sportorg Docs

# Docs

```txt
pip install mkdocs
git clone ...
mkdocs serve
mkdocs build
```
```
make install
make docs
```
8 changes: 4 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
site_name: SportOrg
site_name: Sportorg
site_url: https://sportorg.readthedocs.io/ru/latest/
site_description: 'SportOrg - программное обеспечение для организации соревнований. Поддержка электронных систем отметки SPORTIdent, SFR, SportIduino'
site_description: 'Sportorg - программное обеспечение для организации соревнований. Поддержка электронных систем отметки SPORTIdent, SFR, SportIduino'

repo_name: 'sportorg-docs'
repo_url: 'https://github.com/sportorg/sportorg-docs'

copyright: 'Copyright © 2018 SportOrg'
copyright: 'Copyright © 2024 Sportorg'

theme:
name: readthedocs
Expand Down Expand Up @@ -33,4 +33,4 @@ nav:
- 'О нас':
- about/contributors.md
- 'License': about/LICENSE.md
- about/changelog.md
- about/changelog.md
366 changes: 366 additions & 0 deletions poetry.lock

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[tool.poetry]
name = "sportorg-docs"
version = "0.1.0"
description = ""
authors = ["Danil Akhtarov <[email protected]>"]
readme = "README.md"

[tool.poetry.dependencies]
python = "^3.12"
mkdocs = "^1.5.3"

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
14 changes: 14 additions & 0 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: 2

mkdocs:
configuration: mkdocs.yml

python:
version: 3.12

build:
image: latest

dependencies:
pre:
- pip install mkdocs

0 comments on commit d743495

Please sign in to comment.