No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

docs.yml 3.9KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. # SPDX-FileCopyrightText: 2023 - 2024 Thomas Buck <thomas@xythobuz.de>
  2. # SPDX-License-Identifier: CERN-OHL-S-2.0+
  3. #
  4. # ------------------------------------------------------------------------------
  5. # | Copyright (c) 2023 - 2024 Thomas Buck <thomas@xythobuz.de> |
  6. # | |
  7. # | This source describes Open Hardware and is licensed under the CERN-OHL-S v2 |
  8. # | or any later version. |
  9. # | |
  10. # | You may redistribute and modify this source and make products using it under |
  11. # | the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt) |
  12. # | or any later version. |
  13. # | |
  14. # | This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY, |
  15. # | INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A |
  16. # | PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version) |
  17. # | for applicable conditions. |
  18. # | |
  19. # | Source location: https://github.com/drinkrobotics/dispensy |
  20. # | |
  21. # | As per CERN-OHL-S v2 section 4, should You produce hardware based on this |
  22. # | source, You must where practicable maintain the Source Location visible |
  23. # | on the external case of the Gizmo or other products you make using this |
  24. # | source. |
  25. # ------------------------------------------------------------------------------
  26. name: Docs
  27. # only build single instance of docs for latest main branch
  28. on:
  29. push:
  30. branches:
  31. - master
  32. jobs:
  33. deploy:
  34. runs-on: ubuntu-latest
  35. permissions:
  36. contents: write
  37. pages: write
  38. id-token: write
  39. steps:
  40. - name: Checkout repo
  41. uses: actions/checkout@v4
  42. with:
  43. fetch-depth: 0
  44. - name: Checkout repo submodules
  45. run: git submodule update --init
  46. - name: Install dependencies
  47. run: |
  48. sudo add-apt-repository --yes ppa:kicad/kicad-7.0-releases
  49. sudo apt update
  50. sudo apt install -y --install-recommends kicad pipx libfuse2 libegl1
  51. - name: Install latest mdbook
  52. run: |
  53. tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
  54. url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
  55. mkdir mdbook
  56. curl -sSL $url | tar -xz --directory=./mdbook
  57. echo `pwd`/mdbook >> $GITHUB_PATH
  58. - name: Install (more current) PrusaSlicer
  59. run: |
  60. url="https://github.com/prusa3d/PrusaSlicer/releases/download/version_2.7.1/PrusaSlicer-2.7.1+linux-x64-GTK3-202312121425.AppImage"
  61. mkdir prusa
  62. curl -o prusa/prusa-slicer -sSL $url
  63. chmod a+x prusa/prusa-slicer
  64. echo `pwd`/prusa >> $GITHUB_PATH
  65. - name: Install JLC2KiCad_lib
  66. run: pipx install git+https://github.com/Xyntexx/JLC2KiCad_lib.git@footprint_alignment_workarounds
  67. - name: Fetch part footprints
  68. run: hardware/fetch_jlc.sh
  69. - name: Generate Plots
  70. run: hardware/generate_plot.sh
  71. - name: Build Book
  72. run: docs/generate_docs.sh build
  73. - name: Setup Pages
  74. uses: actions/configure-pages@v2
  75. - name: Upload artifact
  76. uses: actions/upload-pages-artifact@v1
  77. with:
  78. path: 'docs/book'
  79. - name: Deploy to GitHub Pages
  80. id: deployment
  81. uses: actions/deploy-pages@v1