Skip to content

Commit

Permalink
adding Gitbuilding outputs for testing 2
Browse files Browse the repository at this point in the history
  • Loading branch information
jcolomb committed Aug 12, 2024
1 parent 3a7b5c6 commit 5644304
Show file tree
Hide file tree
Showing 13 changed files with 212 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/gitbuilding.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@

name: Deploy Gitbuilding Project to Github Pages

on: [push]

jobs:
build_and_deploy:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- name: Install Python 3
uses: actions/setup-python@v1
with:
python-version: "3.7"
- name: Build
run: |
pip install gitbuilding
gitbuilding build-html
- name: Deploy
uses: JamesIves/github-pages-deploy-action@3.7.1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: _site/
# Automatically remove deleted files from the deploy branch
CLEAN: true
13 changes: 13 additions & 0 deletions RHardware-minimaltemplate.Rproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Version: 1.0

RestoreWorkspace: Default
SaveWorkspace: Default
AlwaysSaveHistory: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: Sweave
LaTeX: pdfLaTeX
23 changes: 23 additions & 0 deletions _build/AssemblyManualSource/Parts/M4x10PanSteel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# M4x10 Pan Head Steel

This is lots of text about some screws?




## Specifications

|Attribute |Value|
|---|---|
|Head|Pan|
|Length|10 mm|
|Material|Stainless Steel|
|Pitch|0.7|


## Suppliers

|Supplier |Part Number|
|---|---|
|RS|[528-817](https://uk.rs-online.com/web/p/machine-screws/0528817/){:target="_blank"}|
|McMasterCarr|[90116A207](https://www.mcmaster.com/90116A207){:target="_blank"}|
12 changes: 12 additions & 0 deletions _build/AssemblyManualSource/Parts/Screwdriver_Philips_No2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# No. 2 Phillips screwdriver

No2 Phillips screwdriver. This is the correct size form an M4 pan head screw




## Specifications

|Attribute |Value|
|---|---|
|Drive Size|No. 2|
14 changes: 14 additions & 0 deletions _build/AssemblyManualSource/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Test Project

This is a great place to start making your documentation!

You should link to a couple of pages:

* [Test Page 1](testpage1.md "")
* [Test Page 2](testpage2.md "")

And you should definitely let people know about the [bill of materials](index_BOM.md) [(csv)](index_BOM.csv) page.

---

[Next page](index_BOM.md)
4 changes: 4 additions & 0 deletions _build/AssemblyManualSource/index_BOM.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Name in documentation Qty Full Name Supplier 1 Part No Link Supplier 2 Part No Link
M4x10 screws 10 M4x10 Pan Head Steel RS 528-817 https://uk.rs-online.com/web/p/machine-screws/0528817/ McMasterCarr 90116A207 https://www.mcmaster.com/90116A207
No. 2 Phillips screwdriver 1 No. 2 Phillips screwdriver
widget 2 Widget Widget Shop Widget1 https://dictionary.cambridge.org/dictionary/english/widget
25 changes: 25 additions & 0 deletions _build/AssemblyManualSource/index_BOM.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Bill of Materials

Download this as a [CSV file](index_BOM.csv)



### Parts

* 10 [M4x10 screws]{: Class="bom"}
* 2 [widget]{: Class="bom"}


### Tools

* 1 [No. 2 Phillips screwdriver]{: Class="bom"}
[No. 2 Phillips screwdriver]:Parts/Screwdriver_Philips_No2.md ""
[M4x10 screws]:Parts/M4x10PanSteel.md ""
[widget]:widget.md ""




---

[Previous page](index.md) | [Next page](testpage1.md)
33 changes: 33 additions & 0 deletions _build/AssemblyManualSource/testpage1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[M4x10 screws]:Parts/M4x10PanSteel.md ""
[No. 2 Phillips screwdriver]:Parts/Screwdriver_Philips_No2.md ""
# Test Page 1

<div markdown="1" class="pagebom">

### Parts

* 5 [M4x10 screws]{: Class="bom"}
* 1 [widget]{: Class="bom"}


### Tools

* 1 [No. 2 Phillips screwdriver]{: Class="bom"}


</div>

## Step 1: Put screws into the widget {:id="put-screws-into-the-widget" class="page-step"}

* Get a [No. 2 Phillips screwdriver] ready
* Take three [M4x10 screws] and screw them into the [widget]

## Step 2: Put more screws into the widget {:id="put-more-screws-into-the-widget" class="page-step"}

* Find the [screwdriver][No. 2 Phillips screwdriver] again
* Take two more [M4x10 screws] and screw them into the same widget
[widget]:widget.md ""

---

[Previous page](index_BOM.md) | [Next page](testpage2.md)
33 changes: 33 additions & 0 deletions _build/AssemblyManualSource/testpage2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[M4x10 screws]:Parts/M4x10PanSteel.md ""
[No. 2 Phillips screwdriver]:Parts/Screwdriver_Philips_No2.md ""
# Test Page 2

<div markdown="1" class="pagebom">

### Parts

* 5 [M4x10 screws]{: Class="bom"}
* 1 [widget]{: Class="bom"}


### Tools

* 1 [No. 2 Phillips screwdriver]{: Class="bom"}


</div>

## Step 1: Put screws into the widget {:id="put-screws-into-the-widget" class="page-step"}

* Get a [No. 2 Phillips screwdriver] ready
* Take three [M4x10 screws] and screw them into the [widget]

## Step 2: Put more screws into the widget {:id="put-more-screws-into-the-widget" class="page-step"}

* Find the [screwdriver][No. 2 Phillips screwdriver] again
* Take two more [M4x10 screws] and screw them into the same widget
[widget]:widget.md ""

---

[Previous page](testpage1.md)
22 changes: 22 additions & 0 deletions _build/AssemblyManualSource/widget.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Widget

This is an example page for a part that needs more information than can be provided
in a part library. You can also add links and images into this page.

---



## Specifications

|Attribute |Value|
|---|---|
|Type|Unknown|
|Quality|Fantastic|


## Suppliers

|Supplier |Part Number|
|---|---|
|Widget Shop|[Widget1](https://dictionary.cambridge.org/dictionary/english/widget){:target="_blank"}|
6 changes: 6 additions & 0 deletions _build/checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Checklist

- [] Complete this readme file
- [] Connect with other people who could be interested in the project, for example on the [GOSH forum](https://forum.openhardware.science ""){:target="_blank"}
- [] Choose and add a license
- [] Decide on using Gitbuilding for assembly manual. Either install and use it, or erase the corresponding folder (AssemblyManualSource).
1 change: 1 addition & 0 deletions _build/missing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# GitBuilding Missing Part
Binary file added _pdf/Documentation.pdf
Binary file not shown.

0 comments on commit 5644304

Please sign in to comment.