Skip to content

Commit

Permalink
fix doc build
Browse files Browse the repository at this point in the history
  • Loading branch information
mateoconlechuga committed Jan 14, 2024
1 parent 018a8be commit 483e052
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 5 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/make.yml
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,6 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Install Documentation Dependencies
if: runner.os == 'Linux'
run: |
sudo apt-get install -y doxygen
cmake -E echo >> $${{matrix.env}}GITHUB_PATH $${{matrix.env}}HOME/.local/bin
Expand All @@ -356,7 +355,7 @@ jobs:
- name: Build Website Documentation
run: make -C ${{env.TOOLCHAIN_PATH}} docs
- name: Disable Jekyll
run: cmake -E touch ${{env.TOOLCHAIN_PATH}}/docs/build/html/.nojekyll
run: touch ${{env.TOOLCHAIN_PATH}}/docs/build/html/.nojekyll
- name: Remove .pickle files
run: find ${{env.TOOLCHAIN_PATH}}/docs/build/ -name '*.pickle' -delete

Expand Down
2 changes: 1 addition & 1 deletion docs/libraries/keypadc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ It supports multi-key presses, and can be used for extremely responsive input co
:depth: 3

Key Detection
-------------------
-------------

Handling key detection properly is a major requirement for a lot of programs.
Detecting a hold can be rather straightforward, but things like a press, release, can sometimes be rather confusing at first.
Expand Down
13 changes: 11 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
docutils==0.16
sphinx==4.5.0
sphinx-design==0.3.0
sphinxcontrib-applehelp==1.0.4
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
sphinx_rtd_theme==1.0.0
docutils==0.16
breathe==4.33.1
Jinja2==3.1.3
sphinx-design==0.3.0
alabaster==0.7.13
imagesize==1.4.1
snowballstemmer==2.2.0

0 comments on commit 483e052

Please sign in to comment.