Skip to content

Commit 1e756e5

Browse files
elveceelvece
committed
restructure to account for new theme, add new build process, update readme
1 parent 4e59b06 commit 1e756e5

File tree

669 files changed

+61332
-245
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

669 files changed

+61332
-245
lines changed

‎.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "sphinx-scylladb-theme"]
2+
path = sphinx-scylladb-theme
3+
url = https://github.com/Start9Labs/sphinx-scylladb-theme.git

‎Makefile

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎README.md

Lines changed: 32 additions & 37 deletions

‎docs/Makefile

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# You can set these variables from the command line.
2+
POETRY = $(HOME)/.poetry/bin/poetry
3+
SPHINXOPTS = -j auto
4+
SPHINXBUILD = $(POETRY) run sphinx-build
5+
PAPER =
6+
BUILDDIR = _build
7+
SOURCEDIR = source
8+
9+
# Internal variables.
10+
PAPEROPT_a4 = -D latex_paper_size=a4
11+
PAPEROPT_letter = -D latex_paper_size=letter
12+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
13+
TESTSPHINXOPTS = $(ALLSPHINXOPTS) -W --keep-going
14+
15+
# the i18n builder cannot share the environment and doctrees with the others
16+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
17+
18+
.PHONY: all
19+
all: dirhtml
20+
21+
.PHONY: pristine
22+
pristine: clean
23+
git clean -dfX
24+
25+
.PHONY: setup
26+
setup:
27+
./_utils/setup.sh
28+
29+
.PHONY: clean
30+
clean:
31+
rm -rf $(BUILDDIR)/*
32+
33+
.PHONY: preview
34+
preview: setup
35+
$(POETRY) run sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml --port 5500
36+
37+
.PHONY: dirhtml
38+
dirhtml: setup
39+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
40+
@echo
41+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
42+
43+
.PHONY: singlehtml
44+
singlehtml: setup
45+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
46+
@echo
47+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
48+
49+
.PHONY: test
50+
test: setup
51+
$(SPHINXBUILD) -b dirhtml $(TESTSPHINXOPTS) $(BUILDDIR)/dirhtml
52+
@echo
53+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
54+
55+
.PHONY: epub
56+
epub: setup
57+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
58+
@echo
59+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
60+
61+
.PHONY: epub3
62+
epub3: setup
63+
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
64+
@echo
65+
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
66+
67+
.PHONY: dummy
68+
dummy: setup
69+
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
70+
@echo
71+
@echo "Build finished. Dummy builder generates no files."
72+
73+
.PHONY: linkcheck
74+
linkcheck: setup
75+
$(SPHINXBUILD) -b linkcheck $(SOURCEDIR) $(BUILDDIR)/linkcheck
76+
77+
.PHONY: multiversion
78+
multiversion: setup
79+
@mkdir -p $(HOME)/.cache/pypoetry/virtualenvs
80+
$(POETRY) run sphinx-multiversion source $(BUILDDIR)/dirhtml
81+
@echo
82+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
83+
84+
.PHONY: multiversionpreview
85+
multiversionpreview: multiversion
86+
$(POETRY) run python3 -m http.server 5500 --directory $(BUILDDIR)/dirhtml

‎docs/_build/dirhtml/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 08addde01d713beb7fdd9a5fa8fa3bb9
4+
tags: d77d1c0d9ca2f4c8421862c7c5a0d620

‎docs/_build/dirhtml/404.html

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="no-js height" lang="en">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width initial-scale=1" />
8+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
9+
10+
<title>Start9</title>
11+
<meta name="description" content="Start9 Product Documentation and Education Guides" />
12+
<link rel="icon" src="/_static/img/favicon.ico" type="image/x-icon" />
13+
<link rel="preconnect" href="https://fonts.gstatic.com" />
14+
<link
15+
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap"
16+
rel="stylesheet"
17+
/>
18+
19+
<link rel="stylesheet" href="/_static/css/main.css" type="text/css" />
20+
<link
21+
rel="stylesheet"
22+
href="/en/latest/_static/css/main.css"
23+
type="text/css"
24+
/>
25+
</head>
26+
<body class="not-found">
27+
<img class="not-found__icon" src="/_static/img/404.jpg" alt="" />
28+
<div class="not-found__text">
29+
<h1>404</h1>
30+
<p>We cannot find what you are looking for!</p>
31+
<p>
32+
<a href="https://docs.start9.com" class="button not-found__button">Home</a>
33+
</p>
34+
</div>
35+
</body>
36+
</html>

‎docs/_build/dirhtml/404/index.html

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="no-js height" lang="en">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width initial-scale=1" />
8+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
9+
10+
<title>Start9</title>
11+
<meta name="description" content="Start9 Product Documentation and Education Guides" />
12+
<link rel="icon" src="/_static/img/favicon.ico" type="image/x-icon" />
13+
<link rel="preconnect" href="https://fonts.gstatic.com" />
14+
<link
15+
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap"
16+
rel="stylesheet"
17+
/>
18+
19+
<link rel="stylesheet" href="/_static/css/main.css" type="text/css" />
20+
<link
21+
rel="stylesheet"
22+
href="/en/latest/_static/css/main.css"
23+
type="text/css"
24+
/>
25+
</head>
26+
<body class="not-found">
27+
<img class="not-found__icon" src="/_static/img/404.jpg" alt="" />
28+
<div class="not-found__text">
29+
<h1>404</h1>
30+
<p>We cannot find what you are looking for!</p>
31+
<p>
32+
<a href="https://docs.start9.com" class="button not-found__button">Home</a>
33+
</p>
34+
</div>
35+
</body>
36+
</html>

‎source/_static/images/ssl/windows/1_windows_mmc.png renamed to ‎docs/_build/dirhtml/_images/1_windows_mmc.png

File renamed without changes.

‎source/_static/images/ssl/windows/2_windows_console_root.png renamed to ‎docs/_build/dirhtml/_images/2_windows_console_root.png

File renamed without changes.

‎source/_static/images/ssl/windows/3_windows_add_certificates.png renamed to ‎docs/_build/dirhtml/_images/3_windows_add_certificates.png

File renamed without changes.

‎source/_static/images/ssl/windows/4_windows_selected_snapin.png renamed to ‎docs/_build/dirhtml/_images/4_windows_selected_snapin.png

File renamed without changes.

‎source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.png renamed to ‎docs/_build/dirhtml/_images/5_windows_trusted_certificate_menu.png

File renamed without changes.

‎source/_static/images/ssl/windows/6_windows_import_cert.png renamed to ‎docs/_build/dirhtml/_images/6_windows_import_cert.png

File renamed without changes.

‎source/_static/images/ssl/windows/7_windows_import_cert_wizard.png renamed to ‎docs/_build/dirhtml/_images/7_windows_import_cert_wizard.png

File renamed without changes.

‎source/_static/images/ssl/windows/8_windows_successful_cert_install.png renamed to ‎docs/_build/dirhtml/_images/8_windows_successful_cert_install.png

File renamed without changes.

‎source/_static/images/tor/about_config.png renamed to ‎docs/_build/dirhtml/_images/about_config.png

File renamed without changes.

‎source/_static/images/ssl/macos/always_trust.png renamed to ‎docs/_build/dirhtml/_images/always_trust.png

File renamed without changes.

‎source/_static/images/tor/autoconfig_url.png renamed to ‎docs/_build/dirhtml/_images/autoconfig_url.png

File renamed without changes.

‎source/_static/images/backup_warning.png renamed to ‎docs/_build/dirhtml/_images/backup_warning.png

File renamed without changes.

‎source/_static/images/diy/balena.png renamed to ‎docs/_build/dirhtml/_images/balena.png

File renamed without changes.

‎source/_static/images/bitcoin_backup_view_no_storage.png renamed to ‎docs/_build/dirhtml/_images/bitcoin_backup_view_no_storage.png

File renamed without changes.

‎source/_static/images/bitcoin_backup_view_storage.png renamed to ‎docs/_build/dirhtml/_images/bitcoin_backup_view_storage.png

File renamed without changes.

‎source/_static/images/service/bitcoin_config.png renamed to ‎docs/_build/dirhtml/_images/bitcoin_config.png

File renamed without changes.

‎source/_static/images/bitcoin_creating_backup.png renamed to ‎docs/_build/dirhtml/_images/bitcoin_creating_backup.png

File renamed without changes.

‎source/_static/images/service/bitcoin_instructions.png renamed to ‎docs/_build/dirhtml/_images/bitcoin_instructions.png

File renamed without changes.

‎source/_static/images/bitcoin_instructions.png renamed to ‎docs/_build/dirhtml/_images/bitcoin_instructions1.png

File renamed without changes.

‎source/_static/images/bitcoin_instructions_view.png renamed to ‎docs/_build/dirhtml/_images/bitcoin_instructions_view.png

File renamed without changes.

‎source/_static/images/bitcoin_view.png renamed to ‎docs/_build/dirhtml/_images/bitcoin_view.png

File renamed without changes.

‎source/_static/images/service/boolean_toggle.png renamed to ‎docs/_build/dirhtml/_images/boolean_toggle.png

File renamed without changes.

‎source/_static/images/ssl/browser/brave_security_settings.png renamed to ‎docs/_build/dirhtml/_images/brave_security_settings.png

File renamed without changes.

‎source/_static/images/ssl/browser/brave_view_certs.png renamed to ‎docs/_build/dirhtml/_images/brave_view_certs.png

File renamed without changes.

‎source/_static/images/ssl/macos/certificate_trusted.png renamed to ‎docs/_build/dirhtml/_images/certificate_trusted.png

File renamed without changes.

‎source/_static/images/ssl/macos/certificate_untrusted.png renamed to ‎docs/_build/dirhtml/_images/certificate_untrusted.png

File renamed without changes.

‎source/_static/images/decrypt_backup.png renamed to ‎docs/_build/dirhtml/_images/decrypt_backup.png

File renamed without changes.

‎source/_static/images/embassy_auto_check_updates.png renamed to ‎docs/_build/dirhtml/_images/embassy_auto_check_updates.png

File renamed without changes.

‎source/_static/images/embassy_config.png renamed to ‎docs/_build/dirhtml/_images/embassy_config.png

File renamed without changes.

‎source/_static/images/embassy_lan_setup.png renamed to ‎docs/_build/dirhtml/_images/embassy_lan_setup.png

File renamed without changes.

‎source/_static/images/embassy_notification.png renamed to ‎docs/_build/dirhtml/_images/embassy_notification.png

File renamed without changes.

‎source/_static/images/embassy_notifications.png renamed to ‎docs/_build/dirhtml/_images/embassy_notifications.png

File renamed without changes.

‎source/_static/images/embassy_wifi.png renamed to ‎docs/_build/dirhtml/_images/embassy_wifi.png

File renamed without changes.

‎source/_static/images/tor/firefox_options_windows.png renamed to ‎docs/_build/dirhtml/_images/firefox_options_windows.png

File renamed without changes.

‎source/_static/images/tor/firefox_proxy.png renamed to ‎docs/_build/dirhtml/_images/firefox_proxy.png

File renamed without changes.

‎source/_static/images/tor/firefox_search.png renamed to ‎docs/_build/dirhtml/_images/firefox_search.png

File renamed without changes.

‎source/_static/images/ssl/browser/firefox_security_settings.png renamed to ‎docs/_build/dirhtml/_images/firefox_security_settings.png

File renamed without changes.

‎source/_static/images/tor/firefox_whitelist.png renamed to ‎docs/_build/dirhtml/_images/firefox_whitelist.png

File renamed without changes.

‎source/_static/images/tor/firefox_whitelist_mobile.png renamed to ‎docs/_build/dirhtml/_images/firefox_whitelist_mobile.png

File renamed without changes.

‎source/_static/images/tor/install_homebrew.png renamed to ‎docs/_build/dirhtml/_images/install_homebrew.png

File renamed without changes.

‎source/_static/images/tor/install_homebrew1.png renamed to ‎docs/_build/dirhtml/_images/install_homebrew1.png

File renamed without changes.

‎source/_static/images/tor/install_tor.png renamed to ‎docs/_build/dirhtml/_images/install_tor.png

File renamed without changes.

‎source/_static/images/tor/network_proxy_type.png renamed to ‎docs/_build/dirhtml/_images/network_proxy_type.png

File renamed without changes.

‎source/_static/images/tor/orbot_apps.png renamed to ‎docs/_build/dirhtml/_images/orbot_apps.png

File renamed without changes.

‎source/_static/images/tor/orbot_menu.png renamed to ‎docs/_build/dirhtml/_images/orbot_menu.png

File renamed without changes.

‎source/_static/images/tor/orbot_settings.png renamed to ‎docs/_build/dirhtml/_images/orbot_settings.png

File renamed without changes.

‎source/_static/images/tor/orbot_start.png renamed to ‎docs/_build/dirhtml/_images/orbot_start.png

File renamed without changes.

‎source/_static/images/tor/orbot_started.png renamed to ‎docs/_build/dirhtml/_images/orbot_started.png

File renamed without changes.

‎source/_static/images/tor/orbot_vpn.png renamed to ‎docs/_build/dirhtml/_images/orbot_vpn.png

File renamed without changes.

‎source/_static/images/diy/pi.png renamed to ‎docs/_build/dirhtml/_images/pi.png

File renamed without changes.

‎source/_static/images/diy/pins.png renamed to ‎docs/_build/dirhtml/_images/pins.png

File renamed without changes.

‎source/_static/images/tor/private_dns_off.png renamed to ‎docs/_build/dirhtml/_images/private_dns_off.png

File renamed without changes.

‎source/_static/images/restore_backup_menu.png renamed to ‎docs/_build/dirhtml/_images/restore_backup_menu.png

File renamed without changes.

‎source/_static/images/restore_backup_submenu.png renamed to ‎docs/_build/dirhtml/_images/restore_backup_submenu.png

File renamed without changes.

‎source/_static/images/restoring_backup.png renamed to ‎docs/_build/dirhtml/_images/restoring_backup.png

File renamed without changes.

‎source/_static/images/secure_lan_setup_page.png renamed to ‎docs/_build/dirhtml/_images/secure_lan_setup_page.png

File renamed without changes.

‎source/_static/images/secure_lan_setup_prompt.png renamed to ‎docs/_build/dirhtml/_images/secure_lan_setup_prompt.png

File renamed without changes.

‎source/_static/images/service/service_properties.png renamed to ‎docs/_build/dirhtml/_images/service_properties.png

File renamed without changes.

‎source/_static/images/tor/socks_remote_dns.png renamed to ‎docs/_build/dirhtml/_images/socks_remote_dns.png

File renamed without changes.

‎source/_static/images/ssl/mobile/ssl_certificate_install_page.PNG renamed to ‎docs/_build/dirhtml/_images/ssl_certificate_install_page.png

File renamed without changes.

‎source/_static/images/ssl/mobile/ssl_ipad_cert_trust.PNG renamed to ‎docs/_build/dirhtml/_images/ssl_ipad_cert_trust.png

File renamed without changes.

‎source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.PNG renamed to ‎docs/_build/dirhtml/_images/ssl_ipad_cert_trust_settings.png

File renamed without changes.

‎source/_static/images/ssl/mobile/ssl_ipad_general_settings.PNG renamed to ‎docs/_build/dirhtml/_images/ssl_ipad_general_settings.png

File renamed without changes.

‎source/_static/images/ssl/mobile/ssl_ipad_install_profile.PNG renamed to ‎docs/_build/dirhtml/_images/ssl_ipad_install_profile.png

File renamed without changes.

‎source/_static/images/ssl/mobile/ssl_ipad_profiles.PNG renamed to ‎docs/_build/dirhtml/_images/ssl_ipad_profiles.png

File renamed without changes.

‎source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG renamed to ‎docs/_build/dirhtml/_images/ssl_setup_app_advanced.png

File renamed without changes.

‎source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG renamed to ‎docs/_build/dirhtml/_images/ssl_setup_app_complete.png

File renamed without changes.

‎source/_static/images/tor/tor_download_windows.png renamed to ‎docs/_build/dirhtml/_images/tor_download_windows.png

File renamed without changes.

‎source/_static/images/tor/tor_windows_install.png renamed to ‎docs/_build/dirhtml/_images/tor_windows_install.png

File renamed without changes.

‎source/_static/images/tor/tor_windows_terminal.png renamed to ‎docs/_build/dirhtml/_images/tor_windows_terminal.png

File renamed without changes.

‎source/_static/images/ssl/windows/windows_download_cert.png renamed to ‎docs/_build/dirhtml/_images/windows_download_cert.png

File renamed without changes.

‎source/contributing/embassyos.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/embassyos.rst.txt

‎source/contributing/services/backups.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/services/backups.rst.txt

‎source/contributing/services/config.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/services/config.rst.txt

‎source/contributing/services/docker.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/services/docker.rst.txt

‎source/contributing/services/index.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/services/index.rst.txt

‎source/contributing/services/instructions.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/services/instructions.rst.txt

‎source/contributing/services/makefile.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/services/makefile.rst.txt

‎source/contributing/services/manifest.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/services/manifest.rst.txt

‎source/contributing/services/overview.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/services/overview.rst.txt

‎source/contributing/services/properties.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/services/properties.rst.txt

‎source/contributing/services/wrapper.rst renamed to ‎docs/_build/dirhtml/_sources/contributing/services/wrapper.rst.txt

‎source/getting-started/diy.rst renamed to ‎docs/_build/dirhtml/_sources/getting-started/diy.rst.txt

‎source/getting-started/introduction.rst renamed to ‎docs/_build/dirhtml/_sources/getting-started/introduction.rst.txt

‎source/getting-started/purchasing.rst renamed to ‎docs/_build/dirhtml/_sources/getting-started/purchasing.rst.txt

0 commit comments

Comments
 (0)