Refactoring docs workflow

This commit is contained in:
Ryan Summers 2021-07-19 13:25:14 +02:00
parent 0918b3445e
commit fc1f4f5aaa
2 changed files with 24 additions and 14 deletions

View File

@ -93,19 +93,19 @@ jobs:
with: with:
ruby-version: 2.7.x ruby-version: 2.7.x
- name: Setup Jekyll - uses: actions/cache@v2
working-directory: docs with:
run: | path: docs/vendor/bundle
gem update keys: ${{runner.os}}-gems-${{ hashFiles('**/Gemfile.lock') }}
gem update bundler restore-keys: |
gem install jekyll bundler ${{ runner.os }}-gems-
bundler install
- uses: actions-rs/toolchain@v1 - uses: actions-rs/toolchain@v1
with: with:
toolchain: stable toolchain: stable
target: thumbv7em-none-eabihf target: thumbv7em-none-eabihf
override: true override: true
- name: Install Deadlinks - name: Install Deadlinks
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with:
@ -126,14 +126,24 @@ jobs:
# auto-generated code. # auto-generated code.
args: --dir target/thumbv7em-none-eabihf/doc --ignore-fragments --check-http --check-intra-doc-links args: --dir target/thumbv7em-none-eabihf/doc --ignore-fragments --check-http --check-intra-doc-links
- name: Move firmware documents - uses: lemonarc/jekyll-action@1.0.0
run: | working-directory: docs
mkdir -p docs/_site/stabilizer
- name: Test User Manual - name: Setup Site
working-directory: docs working-directory: docs
run: | run: |
rake build mkdir _site/stabilizer
mv _site/* _site/stabilizer
mv ../target/thumbv7em-none-eabihf/doc _site/stabilizer/firmware mv ../target/thumbv7em-none-eabihf/doc _site/stabilizer/firmware
rake test
- name: Test User Manual
uses: chabad360/htmlproofer@v1.1
working-directory: docs
with:
directory: "./_site/stabilizer"
arguments:
--assume-extension
--file-ignore "/stabilizer\/firmware\/.*/"
--url-irgnore "/quartiq.de\/stabilizer/"
--allow-hash-href
--typhoeus_config '{"ssl_verify_peer": false}'

View File

@ -3,7 +3,7 @@
/// MQTT broker IPv4 address /// MQTT broker IPv4 address
/// ///
/// In the default configuration, the IP address is defined as 10.34.16.10. /// In the default configuration, the IP address is defined as 10.34.16.10.
pub const MQTT_BROKER: [u8; 4] = [10, 34, 16, 10]; pub const MQTT_BROKER: [u8; 4] = [10, 35, 16, 10];
/// Sampling Frequency /// Sampling Frequency
/// ///