Skip to content

Commit bdc1f99

Browse files
mateoconlechugamateoconlechuga
committed
add doc hotfixes
1 parent 3ef264d commit bdc1f99

File tree

4 files changed

+60
-33
lines changed

4 files changed

+60
-33
lines changed

‎docs/build.sh

Lines changed: 42 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,51 @@
11
#!/bin/bash
22

33
build_documentation () {
4-
export current_version
5-
git checkout ${current_version}
6-
cp -f /tmp/conf.py conf.py
7-
8-
echo "Building documentation for ${current_version}..."
9-
10-
if [ -f 'templates/versions.html' ]; then
11-
cp -f /tmp/versions.html templates/versions.html
12-
sphinx-build . $1
13-
git checkout -- templates/versions.html
14-
else
15-
mkdir -p templates
16-
cp -f /tmp/versions.html templates/versions.html
17-
sphinx-build . $1
18-
rm -rf templates
19-
fi
20-
git checkout -- conf.py
21-
}
4+
export current_version
5+
cp -f /tmp/conf.py conf.py
226

23-
current_version="v9.2"
24-
export versions="master v9.2 v9.1 v9.0"
7+
echo "Building documentation for ${current_version}..."
8+
9+
if [ -f 'templates/versions.html' ]; then
10+
cp -f /tmp/versions.html templates/versions.html
11+
sphinx-build . $1
12+
git checkout -- templates/versions.html
13+
else
14+
mkdir -p templates
15+
cp -f /tmp/versions.html templates/versions.html
16+
sphinx-build . $1
17+
rm -rf templates
18+
fi
19+
git checkout -- conf.py
20+
}
2521

2622
cp -f conf.py /tmp/conf.py
2723
cp -f templates/versions.html /tmp/versions.html
2824

25+
export versions="master v9.2 v9.1 v9.0"
26+
27+
# build default
28+
current_version="v9.2"
29+
git checkout v9.2-docs
2930
build_documentation build/html
30-
for current_version in ${versions}; do
31-
build_documentation build/html/${current_version}
32-
done
31+
32+
# build v9.2
33+
current_version="v9.2"
34+
git checkout v9.2-docs
35+
build_documentation build/html/${current_version}
36+
37+
# build v9.1
38+
current_version="v9.1"
39+
git checkout v9.1
40+
build_documentation build/html/${current_version}
41+
42+
# build v9.0
43+
current_version="v9.0"
44+
git checkout v9.0
45+
build_documentation build/html/${current_version}
46+
47+
# build master
48+
current_version="master"
49+
git checkout master
50+
build_documentation build/html/${current_version}
51+

‎docs/static/contributing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Windows
5555

5656
Get `MinGW <http://www.mingw.org>`_.
5757
The only required pacakges are `mingw32-base` and `mingw32-gcc-g++`.
58-
Make sure the `MinGW\bin` directory is in the system's PATH environment variable.
58+
Make sure the `MinGW\\bin` directory is in the system's PATH environment variable.
5959

6060
Get the `ez80-clang LLVM compiler <https://github.com/jacobly0/llvm-project/wiki>`_.
6161
Make sure the compiler is located in the system's PATH environment variable.
@@ -83,4 +83,4 @@ By default, the toolchain is installed into the root (C:\\CEdev) directory.
8383

8484
This is configurable with :code:`mingw32-make install PREFIX=[LOCATION]`
8585

86-
Finally, copy the previously downloaded `fasmg` and `ez80-clang` executables to the installed `CEdev\bin` directory.
86+
Finally, copy the previously downloaded `fasmg` and `ez80-clang` executables to the installed `CEdev\\bin` directory.

‎docs/static/getting-started.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ Building Programs
3636
Programs are built with the :code:`make` command, executed from a terminal session.
3737
This tutorial explains how to use the CE C Toolchain to build programs using :code:`make`.
3838

39+
.. warning::
40+
41+
On Windows, you may need to install the latest Microsoft Visual C++ Redistributable package if you encounter errors such as :code:`Missing vcruntime140.dll`.
42+
The download can be found `at this link <https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0>`_, depending on your computer you will need to install one of *vc_redist.x86.exe*, *vc_redist.x64.exe*, or *vc_redist.arm64.exe*.
43+
44+
Additionally, your antivirus software (e.g. Windows Defender) may flag binaries in the :code:`CEdev/bin` directory as false positives, and either quarantine the files or prevent them from running.
45+
It it recommended you whitelist or disable scanning in :code:`CEdev/bin` to prevent these false positives from occurring.
46+
3947
Locate the installed `CEdev` folder, and open a session by double-clicking :code:`cedev.bat` on Windows or launching your favorite terminal on Linux/macOS.
4048
Navigate to the `examples` folder using the :code:`cd examples` command.
4149
This folder contains example projects that you can build and modify to learn how to write CE C programs.

‎docs/static/makefile-options.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This is the name of the program variable that will be stored on the calculator.
1515

1616
.. code-block:: makefile
1717
18-
NAME ?= PRGM
18+
NAME = PRGM
1919
2020
ICON
2121
----
@@ -26,7 +26,7 @@ Place a 16x16 image in the same directory as the makefile with the name of whate
2626

2727
.. code-block:: makefile
2828
29-
ICON ?= icon.png
29+
ICON = icon.png
3030
3131
DESCRIPTION
3232
-----------
@@ -37,7 +37,7 @@ The description will be displayed in shells such as `Cesium <https://github.com/
3737

3838
.. code-block:: makefile
3939
40-
DESCRIPTION ?= "My awesome program"
40+
DESCRIPTION = "My awesome program"
4141
4242
COMPRESSED
4343
----------
@@ -50,7 +50,7 @@ To enable this feature, open the project's makefile and edit the line:
5050

5151
.. code-block:: makefile
5252
53-
COMPRESSED ?= YES
53+
COMPRESSED = YES
5454
5555
ARCHIVED
5656
--------
@@ -60,7 +60,7 @@ To enable this feature, open the project's makefile and change the line:
6060

6161
.. code-block:: makefile
6262
63-
ARCHIVED ?= YES
63+
ARCHIVED = YES
6464
6565
DEPS
6666
----
@@ -72,7 +72,7 @@ Define rules for the files after including the main CEdev makefile.
7272
7373
DEPS = $(BINDIR)/levelpack.bin
7474
75-
include $(CEDEV)/meta/makefile.mk
75+
include $(shell cedev-config --makefile)
7676
7777
$(BINDIR)/levelpack.bin:
7878
$(call MKDIR,$(@D))
@@ -87,5 +87,5 @@ These flags are passed to the clang compiler.
8787

8888
.. code-block:: makefile
8989
90-
CFLAGS ?= -Wall -Wextra -Oz
91-
CXXFLAGS ?= -Wall -Wextra -Oz
90+
CFLAGS = -Wall -Wextra -Oz
91+
CXXFLAGS = -Wall -Wextra -Oz

0 commit comments

Comments
 (0)