Go to file

Ad Schellevis c0d7a022b2 API: add python script to harvest API endpoints, so we can avoid https://github.com/opnsense/plugins/issues/1698 easier.		2020-02-16 16:07:36 +01:00
source	fixed some typos (#237 )	2020-02-10 10:20:27 +01:00
themes/opnsense/sass	Fix #83 : Very long words can run out of container	2018-12-19 16:10:42 +01:00
.gitignore	Add Third-party section + Sunnyvalley / Sensei (#190 )	2019-08-05 10:29:36 +02:00
LICENSE	Many typo fixes and some rewording (#80 )	2018-11-08 20:59:18 +01:00
Makefile	Initial version of the freely available OPNsense documentation project, original commiters are listed in LICENSE file.	2018-01-30 11:40:13 +01:00
README.md	API: add python script to harvest API endpoints, so we can avoid https://github.com/opnsense/plugins/issues/1698 easier.	2020-02-16 16:07:36 +01:00
collect_api_endpoints.py	API: add python script to harvest API endpoints, so we can avoid https://github.com/opnsense/plugins/issues/1698 easier.	2020-02-16 16:07:36 +01:00
requirements.txt	enforce newer diagram versions on install	2020-02-16 14:56:23 +01:00

README.md

OPNsense documentation

Welcome to the OPNsense documentation & wiki.
The purpose of this project is to provide OPNsense users with quality documentation.

Contribute

You can contribute to the project in many ways, e.g. testing functionality, sending in bug reports or creating pull requests directly via GitHub. Any help is always very welcome!

License

OPNsense documentation is available under the 2-Clause BSD license:

http://opensource.org/licenses/BSD-2-Clause

Every contribution made to the project must be licensed under the same conditions in order to keep OPNsense truly free and accessible for everybody.

Some pictures are licensed under the Creative Commons Zero (CC0) license:

https://creativecommons.org/publicdomain/zero/1.0/

Logos may be subject to additional copyrights, property rights, trademarks etc. and may require the consent of a third party or the license of these rights. Deciso B.V. does not represent or make any warranties that it owns or licenses any of the mentioned, nor does it grant them.

Prepare build

Install Sphinx, our default theme and contrib packages

pip3 install -r requirements.txt --upgrade

Update API endpoints

A script is provided to update the api endpoint documentation, this can be executed using:

./collect_api_endpoints.py --repo core /path/to/core/repository
./collect_api_endpoints.py --repo plugins /path/to/plugins/repository

Generate HTML documents

make html

(make clean to flush)

Changing theme

Install Sass (http://sass-lang.com/). On macOS, this is done via /Library/Ruby/Gems

gem install --no-user-install sass

Install npm (https://www.npmjs.com/get-npm)
Install Bower (https://bower.io/)

npm install -g bower

Install required stylesheets using bower

bower install wyrm
bower install robotoslab-googlefont
bower install inconsolata-googlefont
bower install font-awesome#4.7.0

(for font-awesome, choose newest)

Build your theme:

sass -I bower_components/wyrm/sass/ -I bower_components/bourbon/dist/ -I bower_components/neat/app/assets/stylesheets/ -I bower_components/font-awesome/scss/ themes/opnsense/sass/theme.sass  > source/_static/css/opnsense.css