Skip to content

Commit 77d5b8a

Browse files
AntonioNDAntonioND
committed
Build the documentation of the SDK repository in this repository
1 parent dacc77c commit 77d5b8a

3 files changed

Lines changed: 213 additions & 13 deletions

File tree

‎.github/workflows/build.yml‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# SPDX-License-Identifier: CC0-1.0
2+
#
3+
# SPDX-FileContributor: Antonio Niño Díaz, 2025
4+
5+
name: Documentation
6+
7+
on:
8+
push:
9+
branches:
10+
- 'master'
11+
paths-ignore:
12+
- '**.md'
13+
workflow_dispatch:
14+
repository_dispatch:
15+
types: [run_build]
16+
17+
permissions:
18+
contents: read
19+
pages: write
20+
id-token: write
21+
packages: write
22+
23+
jobs:
24+
25+
generate_website:
26+
name: Generate website
27+
runs-on: ubuntu-latest
28+
strategy:
29+
fail-fast: true
30+
31+
steps:
32+
- name: Clone project
33+
uses: actions/checkout@v4
34+
with:
35+
repository: 'blocksds/sdk'
36+
ref: 'master'
37+
submodules: 'recursive'
38+
fetch-depth: 0
39+
40+
- name: Install dependencies
41+
run: |
42+
sudo apt-get install doxygen sudo wget
43+
44+
echo ""
45+
echo "[***] Installing Hugo"
46+
echo ""
47+
48+
wget https://github.com/gohugoio/hugo/releases/download/v0.140.2/hugo_extended_0.140.2_linux-amd64.tar.gz
49+
tar -xf hugo_extended_0.140.2_linux-amd64.tar.gz
50+
sudo mv hugo /usr/bin
51+
52+
hugo version
53+
54+
- name: Build documentation
55+
run: |
56+
cd docs
57+
bash build-docs.sh
58+
59+
# Create tarball with everything to upload to GitHub pages
60+
cd public
61+
tar -cvf ../../repo.tar ./*
62+
63+
- name: Upload repo artifact
64+
uses: actions/upload-artifact@v4
65+
with:
66+
name: github-pages
67+
path: repo.tar
68+
if-no-files-found: error
69+
70+
publish_repo:
71+
name: Publish website with GitHub pages
72+
if: contains(github.ref,'refs/heads/master')
73+
needs: [generate_website]
74+
runs-on: ubuntu-latest
75+
environment:
76+
name: github-pages
77+
url: ${{ steps.deployment.outputs.page_url }}
78+
79+
steps:
80+
- name: Setup Pages
81+
uses: actions/configure-pages@v5
82+
83+
- name: Deploy to GitHub Pages
84+
id: deployment
85+
uses: actions/deploy-pages@v4

‎cc0-1.0.txt‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL
6+
SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT
7+
RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS.
8+
CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE
9+
INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES
10+
RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
11+
HEREUNDER.
12+
13+
Statement of Purpose
14+
15+
The laws of most jurisdictions throughout the world automatically confer
16+
exclusive Copyright and Related Rights (defined below) upon the creator and
17+
subsequent owner(s) (each and all, an "owner") of an original work of authorship
18+
and/or a database (each, a "Work").
19+
20+
Certain owners wish to permanently relinquish those rights to a Work for the
21+
purpose of contributing to a commons of creative, cultural and scientific works
22+
("Commons") that the public can reliably and without fear of later claims of
23+
infringement build upon, modify, incorporate in other works, reuse and
24+
redistribute as freely as possible in any form whatsoever and for any purposes,
25+
including without limitation commercial purposes. These owners may contribute to
26+
the Commons to promote the ideal of a free culture and the further production of
27+
creative, cultural and scientific works, or to gain reputation or greater
28+
distribution for their Work in part through the use and efforts of others.
29+
30+
For these and/or other purposes and motivations, and without any expectation of
31+
additional consideration or compensation, the person associating CC0 with a Work
32+
(the "Affirmer"), to the extent that he or she is an owner of Copyright and
33+
Related Rights in the Work, voluntarily elects to apply CC0 to the Work and
34+
publicly distribute the Work under its terms, with knowledge of his or her
35+
Copyright and Related Rights in the Work and the meaning and intended legal
36+
effect of CC0 on those rights.
37+
38+
1. Copyright and Related Rights. A Work made available under CC0 may be
39+
protected by copyright and related or neighboring rights ("Copyright and
40+
Related Rights"). Copyright and Related Rights include, but are not limited
41+
to, the following:
42+
43+
i. the right to reproduce, adapt, distribute, perform, display,
44+
communicate, and translate a Work;
45+
46+
ii. moral rights retained by the original author(s) and/or performer(s);
47+
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
51+
iv. rights protecting against unfair competition in regards to a Work,
52+
subject to the limitations in paragraph 4(a), below;
53+
54+
v. rights protecting the extraction, dissemination, use and reuse of
55+
data in a Work;
56+
57+
vi. database rights (such as those arising under Directive 96/9/EC of
58+
the European Parliament and of the Council of 11 March 1996 on the legal
59+
protection of databases, and under any national implementation thereof,
60+
including any amended or successor version of such directive); and
61+
62+
vii. other similar, equivalent or corresponding rights throughout the
63+
world based on applicable law or treaty, and any national
64+
implementations thereof.
65+
66+
2. Waiver. To the greatest extent permitted by, but not in contravention of,
67+
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
68+
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
69+
and Related Rights and associated claims and causes of action, whether now
70+
known or unknown (including existing as well as future claims and causes of
71+
action), in the Work (i) in all territories worldwide, (ii) for the maximum
72+
duration provided by applicable law or treaty (including future time
73+
extensions), (iii) in any current or future medium and for any number of
74+
copies, and (iv) for any purpose whatsoever, including without limitation
75+
commercial, advertising or promotional purposes (the "Waiver"). Affirmer
76+
makes the Waiver for the benefit of each member of the public at large and
77+
to the detriment of Affirmer's heirs and successors, fully intending that
78+
such Waiver shall not be subject to revocation, rescission, cancellation,
79+
termination, or any other legal or equitable action to disrupt the quiet
80+
enjoyment of the Work by the public as contemplated by Affirmer's express
81+
Statement of Purpose.
82+
83+
3. Public License Fallback. Should any part of the Waiver for any reason be
84+
judged legally invalid or ineffective under applicable law, then the Waiver
85+
shall be preserved to the maximum extent permitted taking into account
86+
Affirmer's express Statement of Purpose. In addition, to the extent the
87+
Waiver is so judged Affirmer hereby grants to each affected person a
88+
royalty-free, non transferable, non sublicensable, non exclusive,
89+
irrevocable and unconditional license to exercise Affirmer's Copyright and
90+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
91+
maximum duration provided by applicable law or treaty (including future time
92+
extensions), (iii) in any current or future medium and for any number of
93+
copies, and (iv) for any purpose whatsoever, including without limitation
94+
commercial, advertising or promotional purposes (the "License"). The License
95+
shall be deemed effective as of the date CC0 was applied by Affirmer to the
96+
Work. Should any part of the License for any reason be judged legally
97+
invalid or ineffective under applicable law, such partial invalidity or
98+
ineffectiveness shall not invalidate the remainder of the License, and in
99+
such case Affirmer hereby affirms that he or she will not (i) exercise any
100+
of his or her remaining Copyright and Related Rights in the Work or (ii)
101+
assert any associated claims and causes of action with respect to the Work,
102+
in either case contrary to Affirmer's express Statement of Purpose.
103+
104+
4. Limitations and Disclaimers.
105+
106+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
107+
surrendered, licensed or otherwise affected by this document.
108+
109+
b. Affirmer offers the Work as-is and makes no representations or
110+
warranties of any kind concerning the Work, express, implied, statutory
111+
or otherwise, including without limitation warranties of title,
112+
merchantability, fitness for a particular purpose, non infringement, or
113+
the absence of latent or other defects, accuracy, or the present or
114+
absence of errors, whether or not discoverable, all to the greatest
115+
extent permissible under applicable law.
116+
117+
c. Affirmer disclaims responsibility for clearing rights of other
118+
persons that may apply to the Work or any use thereof, including without
119+
limitation any person's Copyright and Related Rights in the Work.
120+
Further, Affirmer disclaims responsibility for obtaining any necessary
121+
consents, permissions or other rights required for any use of the Work.
122+
123+
d. Affirmer understands and acknowledges that Creative Commons is not a
124+
party to this document and has no duty or obligation with respect to
125+
this CC0 or use of the Work.

‎readme.md‎

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,4 @@
1-
The documentation of BlocksDS is [here](https://blocksds.skylyrac.net/docs/).
1+
# BlocksDS documentation
22

3-
For an introduction to programming the Nintendo DS with BlocksDS, check
4-
[this tutorial](https://blocksds.skylyrac.net/tutorial/). Note that this
5-
tutorial assumes that you're familiar with the C programming language! It
6-
focuses exclusively on Nintendo DS development, not on programming.
7-
8-
[This](https://github.com/blocksds/awesome-blocksds) is a list of interesting
9-
projects made with BlocksDS.
10-
11-
The GitHub organization of BlocksDS is [here](https://github.com/blocksds).
12-
13-
If you want to report issues with any of the repositories managed by BlocksDS,
14-
do it [here](https://github.com/blocksds/sdk/issues).
3+
This repository contains a GitHub Actions script to build and publish the
4+
documentation of BlocksDS.

0 commit comments

Comments
 (0)