File tree Expand file tree Collapse file tree 1 file changed +6
-6
lines changed Expand file tree Collapse file tree 1 file changed +6
-6
lines changed Original file line number Diff line number Diff line change @@ -15,7 +15,7 @@ directly via GitHub. Any help is always very welcome!
15
15
16
16
OPNsense documentation is available under the 2-Clause BSD license:
17
17
18
- http ://opensource.org/licenses/BSD-2-Clause
18
+ https ://opensource.org/licenses/BSD-2-Clause
19
19
20
20
Every contribution made to the project must be licensed under the
21
21
same conditions in order to keep OPNsense truly free and accessible
@@ -35,13 +35,13 @@ that it owns or licenses any of the mentioned, nor does it grant them.
35
35
On FreeBSD the following packages are required:
36
36
37
37
```
38
- pkg install py39 -pip jpeg-turbo gmake
38
+ pkg install python py311 -pip jpeg-turbo gmake
39
39
```
40
40
41
41
Install Sphinx, our default theme and contrib packages:
42
42
43
43
```
44
- pip[3] install -r requirements.txt --upgrade
44
+ pip install -r requirements.txt --upgrade
45
45
```
46
46
47
47
### Update API endpoints
@@ -57,17 +57,17 @@ executed using:
57
57
#### Generate HTML documents
58
58
59
59
```
60
- make html
60
+ gmake html
61
61
```
62
62
63
- (``` make clean``` to flush)
63
+ (``` gmake clean``` to flush)
64
64
65
65
#### Live preview of HTML documents
66
66
67
67
Use ` sphinx-autobuild ` to track ` source ` for changes and get a live preview served via `` http://localhost:8000 `` .
68
68
69
69
```
70
- pip[3] install sphinx-autobuild
70
+ pip install sphinx-autobuild
71
71
```
72
72
73
73
```
You can’t perform that action at this time.
0 commit comments