Skip to content

Commit 2793bb5

Browse files
author
Sven
authored
ci(workflow): add documentation workflow (#170)
1 parent 0ef5cff commit 2793bb5

File tree

2 files changed

+45
-1
lines changed

2 files changed

+45
-1
lines changed

.github/workflows/docs.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Continuous Integration - Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- "**.rs"
9+
- "Cargo.toml"
10+
- "Cargo.lock"
11+
12+
jobs:
13+
docs:
14+
name: Generate crate documentation
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout sources
18+
uses: actions/checkout@v2
19+
20+
- name: Install Rust toolchain
21+
uses: actions-rs/toolchain@v1
22+
with:
23+
profile: minimal
24+
toolchain: nightly
25+
override: true
26+
27+
- name: Generate documentation
28+
uses: actions-rs/cargo@v1
29+
env:
30+
RUSTDOCFLAGS: "--enable-index-page -Zunstable-options"
31+
with:
32+
command: doc
33+
args: --workspace --no-deps
34+
35+
- name: Deploy documentation
36+
uses: peaceiris/actions-gh-pages@v3
37+
with:
38+
github_token: ${{ secrets.GITHUB_TOKEN }}
39+
publish_dir: ./target/doc

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
env_logger [![Build Status](https://travis-ci.org/sebasmagri/env_logger.svg?branch=master)](https://travis-ci.org/sebasmagri/env_logger) [![Maintenance](https://img.shields.io/badge/maintenance-actively%20maintained-brightgreen.svg)](https://github.com/sebasmagri/env_logger) [![crates.io](https://img.shields.io/crates/v/env_logger.svg)](https://crates.io/crates/env_logger) [![Documentation](https://img.shields.io/badge/docs-current-blue.svg)](https://docs.rs/env_logger)
1+
# env_logger
2+
[![Build Status](https://travis-ci.org/sebasmagri/env_logger.svg?branch=master)](https://travis-ci.org/sebasmagri/env_logger)
3+
[![Maintenance](https://img.shields.io/badge/maintenance-actively%20maintained-brightgreen.svg)](https://github.com/sebasmagri/env_logger)
4+
[![crates.io](https://img.shields.io/crates/v/env_logger.svg)](https://crates.io/crates/env_logger)
5+
[![Documentation](https://docs.rs/env_logger/badge.svg)](https://docs.rs/env_logger)
6+
[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)](https://env-logger-rs.github.io/env_logger)
27
==========
38

49
Implements a logger that can be configured via environment variables.

0 commit comments

Comments
 (0)