284 Commits

Author SHA1 Message Date
James Valleroy
2774f06bdb
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2021-08-30 20:01:13 -04:00
Sunil Mohan Adapa
673ed475b7
doc/dev: Drop seemingly irrelevant automodule reference
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
2021-08-17 19:42:23 -07:00
fliu
585433d427
doc/dev: Using mocking instead of importing external modules
[sunil: Expand the full list of modules]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2021-08-17 19:42:20 -07:00
James Valleroy
7159e2f735
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2021-08-16 19:18:25 -04:00
James Valleroy
1ba3892750
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2021-05-31 19:00:14 -04:00
James Valleroy
d595921903
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2021-04-19 20:36:57 -04:00
Carlos Henrique Lima Melara
0ce610c074
docs: Set the version attribute as required instead of optional
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2021-04-17 09:55:06 -07:00
Carlos Henrique Lima Melara
08a7c7870e
docs: Add missing imports in tutorial as pointed in #2078
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2021-04-17 09:54:54 -07:00
Carlos Henrique Lima Melara
213e01abcd
doc: Add filename to code snippets in tutorial
[sunil: Add caption for another file too]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2021-04-17 09:53:55 -07:00
Sunil Mohan Adapa
e0ebfecc27
Update copyright year
Closes: #2079.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
2021-04-14 16:10:14 -07:00
Joseph Nuthalapati
4b0899fd65
docs: Improve Developer Documentation index page
- Improved readability.
- Changed hierarchy of headings.
- Reduced emphasis on unnecessary/redundant things.
- Added links to go back to the main websites.

Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2021-03-07 07:14:30 -05:00
James Valleroy
2fd66b93f1
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2021-02-28 20:53:59 -05:00
Joseph Nuthalapati
ceacde67b9
coturn: Add new component for usage of coturn by other apps
Sunil:

 - Add TurnConfiguration to reference documentation. Add more details in
 docstrings.

 - Rename the component to TurnConsumer since 'Component' in the name is
 redundant and unconventional. Also, hopefully, the component will retain the
 API over multiple TURN servers.

 - Log when notifying other components about configuration change.

 - Use TurnConfiguration class more widely.

 - Refactor for simplicity.

 - Additional tests.

 - Move URI generation code into TurnConfiguration.

Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2021-02-28 16:28:41 -08:00
James Valleroy
8e36d61ba4
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2021-02-11 17:59:28 -05:00
James Valleroy
7e70e11b61
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2021-02-06 00:40:02 -05:00
James Valleroy
80d104e0eb
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2021-01-25 21:07:51 -05:00
James Valleroy
910e381ac6
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2021-01-11 19:57:31 -05:00
Sunil Mohan Adapa
b378305f58
doc: dev: Update the tutorial to reflect latest API/code
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Veiko Aasa <veiko17@disroot.org>
2021-01-04 13:47:41 +02:00
Sunil Mohan Adapa
838a2ede8c
doc: dev: Update documentation on calling clients validation
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Veiko Aasa <veiko17@disroot.org>
2021-01-04 13:47:40 +02:00
Sunil Mohan Adapa
5f3c691c38
doc: dev: Update documentation for using backup component
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Veiko Aasa <veiko17@disroot.org>
2021-01-04 13:47:39 +02:00
James Valleroy
f15a6f8d55
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-12-28 20:50:46 -05:00
James Valleroy
287f6560da
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-12-19 19:17:39 -05:00
James Valleroy
dade7e7e07
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-12-14 19:30:49 -05:00
James Valleroy
6bff26dc78
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-11-30 18:34:46 -05:00
James Valleroy
18d7014854
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-11-23 18:37:10 -05:00
James Valleroy
9ac69d00c1
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-11-16 20:48:57 -05:00
James Valleroy
619c0c3a6a
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-11-07 08:44:23 -05:00
James Valleroy
a41020b077
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-11-02 19:45:46 -05:00
Sunil Mohan Adapa
6180e3a051
doc: wikiparser: Fix issue with running parser outside doc/ dir
Use a path relative to the script path when checking for existence of manual
pages.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-10-30 10:59:08 -07:00
James Valleroy
085e3ffef3
wikiparser: Exit with return value 1 on test failure
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-10-30 10:59:02 -07:00
James Valleroy
d4d4f0939e
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-10-19 20:38:37 -04:00
James Valleroy
47c82e4241
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-10-05 19:25:31 -04:00
Sunil Mohan Adapa
3f4bd9416d
doc: dev: Link to list of potential apps from tutorial
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2020-09-29 21:18:11 -04:00
Sunil Mohan Adapa
514a04d643
doc: Before fetching, drop all old to cleanup deleted pages/images
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2020-09-28 16:42:32 -04:00
James Valleroy
33dccebae7
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-09-23 07:35:21 -04:00
James Valleroy
840b31f08c
doc: Fetch latest manual
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-09-15 17:42:22 -04:00
Sunil Mohan Adapa
bb28ac1b72
doc: manual: Replace manual icons to drop CC 2.5 license
Tests:

- Affected sections/pages of the manual are: Firewall, Hardware and VirtualBox.
Confirm by diffing with manual generated without the code changes.

- Open all affected pages and the full manual page and confirm that images have
changed.

- Check all affected pages and the full manual page in FreedomBox interface and
confirm that images have changed.

- Check all affected sections in the generated PDF.

- Repeat tests for English and Spanish manuals.

- No lintian warnings related to debian/copyright file.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2020-09-15 15:23:29 -04:00
Sunil Mohan Adapa
04a0fd7b78
doc: wikiparser: Show icons with full size
Setting the height to 26 in the XML file results in HTML getting a 16px size.
16x16 is original size of all the icons. This was first proposed with a size of
20 in the original wikiparser MR.

Tests:

- Affected sections/pages of the manual are: Firewall, Hardware and VirtualBox.
Confirm by diffing with manual generated without the code changes.

- Open all affected pages and the full manual page and confirm that images sizes
are 16px (original size).

- Check all affected pages and the full manual page in FreedomBox interface and
confirm that images sizes are 16px (original size).

- Check all affected sections in the generated PDF.

- Repeat tests for English and Spanish manuals.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2020-09-15 15:23:27 -04:00
Sunil Mohan Adapa
57c60d9ac6
doc: wikiparser: Use icons from the icons directory
Currently some icons are duplicated between the images/ directory and
images/icons/ directory. De-duplicate and only use the icons from images/icons
directory.

Tests:

- Affected sections/pages of the manual are: Firewall, Hardware and VirtualBox.
Confirm by diffing with manual generated without the code changes.

- Open all affected pages and the full manual page and confirm that images are
loading properly.

- Check all affected pages and the full manual page in FreedomBox interface and
confirm that images are loading properly.

- Check all affected sections in the generated PDF.

- Repeat tests for English and Spanish manuals.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2020-09-15 15:23:24 -04:00
Sunil Mohan Adapa
1b7349867e
doc: manual: Fetch latest manual, remove non-existent images/pages
Remove all .raw.wiki files and images (except icons). Then fetch the latest
manual.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-09-14 23:19:35 -07:00
Sunil Mohan Adapa
95c99bf3ce
doc: wikiparser: Reduce build verbosity
- Make begin and end markers the default values in the wikiparser arguments so
that they don't have to passed in every time.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-09-09 01:56:31 -07:00
Sunil Mohan Adapa
099d877b8f
doc: wikiparser: Make it easier to run with a #! at the top
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-09-09 01:56:28 -07:00
Sunil Mohan Adapa
95452c1313
doc: wikiparser: Fix issue with some URL containing dup. lang part
When getting context in included images, the original context might already have
a language component. Don't add it again if it does.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-09-09 01:56:25 -07:00
Sunil Mohan Adapa
0296cfc97f
doc: wikiparser: Fix a minor flake8 issue
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-09-09 01:55:50 -07:00
Fioddor Superconcentrado
42037b8330
doc: wikiparser: Resolve URLs for locally available pages
Closes: #1793

resolve_url() now checks for local help pages and shortcuts the links that point
to them to the local copy. Unit doctests have been included also. Expectations
of 2 preexisting tests resulted impacted by the new logic (shortcutted links)
and were adapted accordingly. New doctests unveiled some rough edge of the
previous logic, so the processing of keyword-protocolled links was fine-tuned to
pollish them.

Signed-off-by: Fioddor Superconcentrado <fioddor@gmail.com>
[sunil: Fixed minor indentation, flake8 issues, styling, comments]
[sunil: Use file exists checking instead of iterating directory]
[sunil: Stricter checking using regex for possible local URLs]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-09-09 01:55:15 -07:00
Sunil Mohan Adapa
14035f51e7
doc: Fetch latest manual
- To get WireGuard pages.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-08-31 14:29:10 -07:00
James Valleroy
9a4c6a78a3
test-wikiparser: Remove fixes.xslt step
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-08-28 12:14:00 -04:00
James Valleroy
ce642e3e87
wikiparser: Don't render Admonition with style comment
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
2020-08-28 12:13:28 -04:00
Sunil Mohan Adapa
bf2518bd0d
manual: Fetch latest images
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2020-08-28 12:10:55 -04:00
James Valleroy
53891a900f
manual: Remove checked-in xml files
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2020-08-28 12:10:49 -04:00