Skip to content

Commit

Permalink
Update CI configurations, Broken section links (#164)
Browse files Browse the repository at this point in the history
* update readme, mkdocs urls

* remove YAML for Travis CI

* ci: create test workflow for MkDocs

* mkdocs: fix introduction, references
  • Loading branch information
luncliff authored Sep 12, 2023
1 parent e84fb6a commit 249a8ea
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 37 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/test-mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: "Test MkDocs"

on: [push, workflow_dispatch]

permissions:
contents: read

jobs:
mkdocs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.11
architecture: x64

- name: "Run pip install"
run: >
python3 -m pip install -r requirements.txt
- name: "Run MkDocs(build)"
run: >
python3 -m mkdocs build --site-dir _site
30 changes: 0 additions & 30 deletions .travis.yml

This file was deleted.

2 changes: 1 addition & 1 deletion ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
> -- _비야네 스트롭스트룹 (Bjarne Stroustrup)_
* ISO C++ 최신버전(영문): https://github.com/isocpp/CppCoreGuidelines
* 한글: https://www.cppkorea.org/CppCoreGuidelines
* 한글: http://cppkorea.github.io/CppCoreGuidelines/

## C++ 핵심 가이드라인 한글화 프로젝트

Expand Down
10 changes: 4 additions & 6 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
site_name: C++ 핵심 가이드라인
site_description: "C++ 핵심 가이드라인 한글화 프로젝트"
site_author: C++ Korea
site_url: http://www.cppkorea.org/CppCoreGuidelines
site_url: https://cppkorea.github.io/CppCoreGuidelines/

repo_name: CppKorea/CppCoreGuidelines
repo_url: http://github.com/CppKorea/CppCoreGuidelines
repo_url: https://github.com/CppKorea/CppCoreGuidelines

copyright: "Copyright (c) Standard C++ Foundation and its contributors"

Expand Down Expand Up @@ -42,10 +42,8 @@ theme:
docs_dir: sections
nav:
- Overview: home.md
- Introduction:
- Introduction.md
- References:
- References.md
- Introduction: Introduction.md
- References: References.md
- Sections:
- Architecture: Architecture.md
- Class: Class.md
Expand Down

0 comments on commit 249a8ea

Please sign in to comment.