Fixing links, adding htmlproofer

This commit is contained in:
Ryan Summers 2021-07-16 11:23:01 +02:00
parent 9c6b8b48d3
commit 0c3a99b6b6
6 changed files with 49 additions and 4 deletions

View File

@ -88,6 +88,19 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- uses: actions/setup-ruby@v1
with:
ruby-version: 2.7.x
- name: Setup Jekyll
working-directory: docs
runs: |
gem update
gem update bundler
gem install jekyll bundler
bundler install
- uses: actions-rs/toolchain@v1 - uses: actions-rs/toolchain@v1
with: with:
toolchain: stable toolchain: stable
@ -104,8 +117,18 @@ jobs:
with: with:
command: doc command: doc
args: --no-deps -p miniconf -p dsp -p ad9959 -p stabilizer args: --no-deps -p miniconf -p dsp -p ad9959 -p stabilizer
- name: cargo deadlinks - name: cargo deadlinks
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with:
command: deadlinks command: deadlinks
args: --dir target/thumbv7em-none-eabihf/doc args: --dir target/thumbv7em-none-eabihf/doc
- name: Move firmware documents
runs: |
mkdir -p docs/_site/stabilizer
mv targets/thumbv7em-none-eabihf/doc docs/_site/stabilizer/firmware
- name: Test User Manual
working-directory: docs
runs: rake test

View File

@ -1,3 +1,4 @@
source 'https://rubygems.org' source 'https://rubygems.org'
gem "just-the-docs" gem "just-the-docs"
gem "jekyll-remote-theme" gem "jekyll-remote-theme"
gem "html-proofer"

View File

@ -8,9 +8,19 @@ GEM
em-websocket (0.5.2) em-websocket (0.5.2)
eventmachine (>= 0.12.9) eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0) http_parser.rb (~> 0.6.0)
ethon (0.14.0)
ffi (>= 1.15.0)
eventmachine (1.2.7-x64-mingw32) eventmachine (1.2.7-x64-mingw32)
ffi (1.15.3-x64-mingw32) ffi (1.15.3-x64-mingw32)
forwardable-extended (2.6.0) forwardable-extended (2.6.0)
html-proofer (3.19.2)
addressable (~> 2.3)
mercenary (~> 0.3)
nokogumbo (~> 2.0)
parallel (~> 1.3)
rainbow (~> 3.0)
typhoeus (~> 1.3)
yell (~> 2.0)
http_parser.rb (0.6.0) http_parser.rb (0.6.0)
i18n (1.8.10) i18n (1.8.10)
concurrent-ruby (~> 1.0) concurrent-ruby (~> 1.0)
@ -53,9 +63,16 @@ GEM
rb-fsevent (~> 0.10, >= 0.10.3) rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10) rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0) mercenary (0.4.0)
nokogiri (1.11.7-x64-mingw32)
racc (~> 1.4)
nokogumbo (2.0.5)
nokogiri (~> 1.8, >= 1.8.4)
parallel (1.20.1)
pathutil (0.16.2) pathutil (0.16.2)
forwardable-extended (~> 2.6) forwardable-extended (~> 2.6)
public_suffix (4.0.6) public_suffix (4.0.6)
racc (1.5.2)
rainbow (3.0.0)
rake (13.0.6) rake (13.0.6)
rb-fsevent (0.11.0) rb-fsevent (0.11.0)
rb-inotify (0.10.1) rb-inotify (0.10.1)
@ -68,12 +85,16 @@ GEM
ffi (~> 1.9) ffi (~> 1.9)
terminal-table (2.0.0) terminal-table (2.0.0)
unicode-display_width (~> 1.1, >= 1.1.1) unicode-display_width (~> 1.1, >= 1.1.1)
typhoeus (1.4.0)
ethon (>= 0.9.0)
unicode-display_width (1.7.0) unicode-display_width (1.7.0)
yell (2.2.2)
PLATFORMS PLATFORMS
x64-mingw32 x64-mingw32
DEPENDENCIES DEPENDENCIES
html-proofer
jekyll-remote-theme jekyll-remote-theme
just-the-docs just-the-docs

View File

@ -46,7 +46,7 @@ application requirements. Some examples of parameters that may require configura
Parameters are configured by editing `src/configuration.rs`. Parameters are configured by editing `src/configuration.rs`.
Refer to the [documentation]({{site.baseurl}}/firmware/stabilizer/configuration.rs) for more Refer to the [documentation]({{site.baseurl}}/firmware/stabilizer/configuration/index.html) for more
information on parameters. information on parameters.
When these parameters are updated, firmware must be built and flashed onto Stabilizer before they When these parameters are updated, firmware must be built and flashed onto Stabilizer before they

View File

@ -49,7 +49,7 @@ buffering requirements.
In its most basic form, telemetry publishes the latest ADC input voltages, DAC output voltages, and In its most basic form, telemetry publishes the latest ADC input voltages, DAC output voltages, and
digital input states. digital input states.
Refer to the respective [application documentation](/#applications) for more information on telemetry. Refer to the respective [application documentation]({{site.baseurl}}/#applications) for more information on telemetry.
## Livestream ## Livestream
@ -60,4 +60,4 @@ host computer for further analysis.
Livestreamed data is sent with "best effort" - it's possible that data may be lost either due to Livestreamed data is sent with "best effort" - it's possible that data may be lost either due to
network congestion or by Stabilizer. network congestion or by Stabilizer.
Refer to the the respective [application documentation](/#applications) for more information. Refer to the the respective [application documentation]({{site.baseurl}}/#applications) for more information.

View File

@ -37,7 +37,7 @@ python miniconf.py --broker localhost dt/sinara/dual-iir/00-11-22-33-44-55 strea
The prefix can be found for a specific device by looking at the topic on which telemetry that is The prefix can be found for a specific device by looking at the topic on which telemetry that is
being published. being published.
Refer to the [application documentation](/#applications) for the exact settings and values exposed Refer to the [application documentation]({{site.baseurl}}/#applications) for the exact settings and values exposed
for each application. for each application.
The rules for constructing `path` values are documented in [`miniconf`'s The rules for constructing `path` values are documented in [`miniconf`'s