Skip to content

Commit

Permalink
chore: Release preparation
Browse files Browse the repository at this point in the history
  • Loading branch information
zfields committed Mar 7, 2021
1 parent 9dda42e commit 9087ef6
Show file tree
Hide file tree
Showing 20 changed files with 368 additions and 414 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
.vscode/
docs/html/

# Secrets
.gitconfig
.netrc

# Artifacts
*.gc*
a.out
nes_rob_tests
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
url = https://github.com/catchorg/Catch2.git
[submodule "test/FakeIt"]
path = test/FakeIt
url = https://github.com/eranpeer/FakeIt.git
url = https://github.com/zfields/FakeIt.git
27 changes: 27 additions & 0 deletions docs/.publish-gh-pages.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#!/bin/sh

# Rebuild Documentation
rm -rf /nes-rob/docs/html/
doxygen Doxyfile

# Prepare Git
git branch --delete --force gh-pages
git checkout -b gh-pages

# Scrub Repository
rm -f * docs/* .gitmodules
rm -rf docs/img/ examples/ src/ test/

# Promote HTML
mv docs/html/* .

# Publish API Documentation to gh-pages
git add .
git commit -m "\`gh-pages\` API Documentation"
git push origin gh-pages --force

# Restore Repository
git checkout main
git reset HEAD --hard
git clean -fdx
git submodule update
15 changes: 10 additions & 5 deletions docs/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,26 @@
# Launch development environment
# $ docker run --rm --volume $(pwd)/..:/nes-rob/ nes-rob-docs

# Restore ownership
# $ sudo chown -R <user>:<group> ..

# Base Image
FROM alpine

# Configure Git
COPY .gitconfig /root/
COPY .netrc /root/

# Yarn Install Requirements
RUN ["ash", "-c", "\
apk add --no-cache \
doxygen \
ttf-freefont \
git \
graphviz \
ttf-freefont \
"]

WORKDIR /nes-rob/

# Remove and Rebuild Documentation
CMD ["ash", "-c", "\
rm -rf /nes-rob/docs/html/ \
&& doxygen Doxyfile \
"]
CMD ["/nes-rob/docs/.publish-gh-pages.sh"]
246 changes: 0 additions & 246 deletions docs/api.md

This file was deleted.

Binary file added docs/img/installing-nesrob.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 9087ef6

Please sign in to comment.