Skip to content

Commit f1cf79d

Browse files
committed
update entire repository; make it API document repository
1 parent d4bc149 commit f1cf79d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+29
-4262
lines changed

.github/workflows/document.yaml

+5-7
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,13 @@ jobs:
2929
make initdir html
3030
RELEASE_VERSION=${GITHUB_REF#refs/*/}
3131
DOWNLOAD_URL_BASE=$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/releases/download
32-
TARGET=`ls doc/Out/*.html`
33-
TARGET=${TARGET#doc/Out/}
34-
qr ${DOWNLOAD_URL_BASE}/${RELEASE_VERSION}/${TARGET//.html/}.pdf > doc/images/QRcode.png
32+
TARGET=`ls Out/*.html`
33+
TARGET=${TARGET#Out/}
34+
qr ${DOWNLOAD_URL_BASE}/${RELEASE_VERSION}/${TARGET//.html/}.pdf > images/QRcode.png
3535
- name: Build document
3636
run: |
37-
make initdir html docx pdf apidoc
37+
make initdir docx
3838
- name: Upload artifact files (at a push)
3939
uses: actions/upload-artifact@v3
4040
with:
41-
path: |
42-
doc/Out
43-
micropython/doc/Out
41+
path: Out

Dockerfile

-25
This file was deleted.

Makefile

+24-40
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,24 @@
1-
all: html
2-
3-
html:
4-
cd doc && make html && cd -
5-
6-
pdf:
7-
cd doc && make pdf && cd -
8-
9-
docx:
10-
cd doc && make docx && cd -
11-
12-
clean:
13-
cd doc && make clean && cd -
14-
cd micropython/doc && make clean
15-
16-
init:
17-
cd doc && make init && cd -
18-
cd micropython/doc && make init
19-
20-
initdir:
21-
cd doc && make initdir && cd -
22-
cd micropython/doc && make initdir
23-
24-
apidoc: apidoc-docx
25-
26-
apidoc-html:
27-
cd micropython/doc && make html && cd -
28-
29-
apidoc-pdf:
30-
cd micropython/doc && make pdf && cd -
31-
32-
apidoc-docx:
33-
cd micropython/doc && make docx && cd -
34-
35-
docker:
36-
docker build -t rpi-pico-build .
37-
38-
firmware:
39-
cd micropython && \
40-
docker run --rm -it -v $(PWD)/micropython:/root rpi-pico-build bash /root/firmware_builder.sh
1+
ifeq ($(OS),Windows_NT)
2+
HOME = C:/Users/$(USERNAME)
3+
endif
4+
PIPBASE= $(shell get-pip-base)
5+
PANSTYLES= $(PIPBASE)/var
6+
MISC= $(PANSTYLES)/pandoc_misc
7+
MISC_SYS = $(MISC)/system
8+
MISC_USER = $(MISC)/user
9+
include $(MISC_SYS)/Makefile.in
10+
PROJECT= `pwd`
11+
12+
## userland: uncomment and replace
13+
#MDDIR := markdown
14+
#DATADIR := data
15+
#TARGETDIR := Out
16+
#IMAGEDIR := images
17+
#CONFIG := config.yaml
18+
#INPUT := TITLE.md
19+
SYSTEM_DOCXFRONTPAGE := $(MDDIR)/frontpage.md
20+
TARGET := RasPiPico-Micro-SCPI-API-Reference-$(DATE)-$(HASH)
21+
#REVERSE_INPUT := reverse-input.docx
22+
REFERENCE := ./local_reference.docx
23+
##
24+
include $(MISC_SYS)/Makefile

doc/.circleci/config.yml

-65
This file was deleted.

doc/.gitignore

-5
This file was deleted.

doc/Makefile

-24
This file was deleted.

0 commit comments

Comments
 (0)