diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..8d3beae --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "sphinx-scylladb-theme"] + path = sphinx-scylladb-theme + url = https://github.com/Start9Labs/sphinx-scylladb-theme.git diff --git a/Makefile b/Makefile deleted file mode 100644 index d0c3cbf..0000000 --- a/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/README.md b/README.md index 73ec6fa..0c6e4e6 100644 --- a/README.md +++ b/README.md @@ -2,41 +2,44 @@ At Start9, we see great value in maintaining clear and accurate documentation for our already simple and friendly products. These docs are a continuous work-in-progress, and we welcome contributions from our partners and customers. -## Runbook +## Toolkit -This project uses: -- [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) -- [Restructured Text](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html) -- [Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/) +These are the basic tools this project uses: -### Dependencies +### Markup language -Install [python3](https://docs.python-guide.org/starting/install3/osx/) +Docs are written in [RestructuredText](https://www.sphinx-doc.org/es/master/usage/restructuredtext/index.html). RestructuredText is a file format for textual data used primarily for technical documentation. -Install sphinx and dependencies: -``` -brew install sphinx-doc -pip3 install sphinx-autobuild -pip3 install sphinx-book-theme || pip install git+https://github.com/executablebooks/sphinx-book-theme.git@master -pip3 install sphinxcontrib.yt -pip3 install sphinx-multiversion -``` +### Sphinx -### Development +The tool we used to converts [restructuredText](https://www.sphinx-doc.org) and Markdown to HTML. +Sphinx also has directives and extensions to add additional options for formatting the text. -Run: `sphinx-autobuild source build/html` to activate a live-reload environment on `localhost:8000`. +### Scylla Sphinx Theme -To run in development mode when actively changing js/css files run: `sphinx-autobuild source build/html source/_static/js/main.js source/_static/default.css`. This will auto reload with changes to noted files. +A customized version of the [theme](https://github.com/scylladb/sphinx-scylladb-theme) used by Scylla documentation projects. It also adds a set of custom functionalities and styles. -The main configuration file for this project is located at `./source/conf.py`. +### Multiversion extension -The navigation structure is aligned with the folder/file organization under `./source/`. This is where the individual page `.rst` files live and can be edited. +The [extension](https://github.com/Holzhaus/sphinx-multiversion) used to build docs for different versions. -If any css or table of contents organization changes, run: `make clean html`. +## Dependencies + +Install [pyenv](https://github.com/pyenv/pyenv) + +## Development + +When editing these files, begin a livereload environment by running `make preview` while in the `./docs/` directory. + +When editing any css or table of contents organization changes, the livereload environment must be ended and `make clean` run before starting `make preview` again. + +### Versioning +- Build for versioning (must be on master) branch: `make multiversion` +- To view version metadata: `make multiversionpreview` ## Contributing to the docs -If you notice a mistake in the docs, or you have an idea for improving them, we would like to know about it. You can either fix the mistake yourself and submit a pull request, or you can report the mistake by submitting an issue. +If you notice a mistake in the docs, or you have an idea for improving them, we would like to know about it. You can either fix the mistake yourself and submit a pull request, or you can report the mistake by submitting an `issue `__ . ### Submitting an issue @@ -44,21 +47,13 @@ Click on the "Issues" tab in the top navbar. Provide a good title and describe c ### Submitting a pull request -Click on the "Pull requests" tab in the top navbar. Select the green "New pull request button" in the top right section. Select your branch for the compare dropdown, and master as the base. Provide an appropriate title and summary of the changes in the pull request description. Changes will be reviewed and merged when satisfactory. +Click on the "Pull requests" tab in the top navbar. Select the green "New pull request button" in the top right section. Select your branch for the compare dropdown, and master as the base. Provide an appropriate title and summary of the changes in the pull request description. Changes will be reviewed and merged when satisfactory. ## Helpful Resources -- [Lists in RST](https://sublime-and-sphinx-guide.readthedocs.io/en/latest/lists.html) - -## Updating theme - -To update Sphinx Book Theme: -- `pip uninstall sphinx-book-theme` (needed to properly propagate new changes for some undetermined reason) -- `pip install sphinx-book-theme==` || `pip install git+https://github.com/executablebooks/sphinx-book-theme.git@` eg. `pip install sphinx-book-theme==0.0.42` - -To deploy theme update: -- Build and publish according to production release process - -## Versioning -- Build for versioning: `sphinx-multiversion source build/html` -- To view version metadata: `sphinx-multiversion source build/html --dump-metadata` +### Sphinx and RST syntax guides: +http://sphinx-doc.org/rest.html +http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html +http://www.siafoo.net/help/reST +http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html +https://sublime-and-sphinx-guide.readthedocs.io/en/latest/lists.html \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..39b82c1 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,86 @@ +# You can set these variables from the command line. +POETRY = $(HOME)/.poetry/bin/poetry +SPHINXOPTS = -j auto +SPHINXBUILD = $(POETRY) run sphinx-build +PAPER = +BUILDDIR = _build +SOURCEDIR = source + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR) +TESTSPHINXOPTS = $(ALLSPHINXOPTS) -W --keep-going + +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR) + +.PHONY: all +all: dirhtml + +.PHONY: pristine +pristine: clean + git clean -dfX + +.PHONY: setup +setup: + ./_utils/setup.sh + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: preview +preview: setup + $(POETRY) run sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml --port 5500 + +.PHONY: dirhtml +dirhtml: setup + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: setup + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: test +test: setup + $(SPHINXBUILD) -b dirhtml $(TESTSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: epub +epub: setup + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: setup + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: dummy +dummy: setup + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." + +.PHONY: linkcheck +linkcheck: setup + $(SPHINXBUILD) -b linkcheck $(SOURCEDIR) $(BUILDDIR)/linkcheck + +.PHONY: multiversion +multiversion: setup + @mkdir -p $(HOME)/.cache/pypoetry/virtualenvs + $(POETRY) run sphinx-multiversion source $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: multiversionpreview +multiversionpreview: multiversion + $(POETRY) run python3 -m http.server 5500 --directory $(BUILDDIR)/dirhtml diff --git a/docs/_build/dirhtml/.buildinfo b/docs/_build/dirhtml/.buildinfo new file mode 100644 index 0000000..cf694c6 --- /dev/null +++ b/docs/_build/dirhtml/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 08addde01d713beb7fdd9a5fa8fa3bb9 +tags: d77d1c0d9ca2f4c8421862c7c5a0d620 diff --git a/docs/_build/dirhtml/404.html b/docs/_build/dirhtml/404.html new file mode 100644 index 0000000..4ab50e9 --- /dev/null +++ b/docs/_build/dirhtml/404.html @@ -0,0 +1,36 @@ + + + + + + + + + + Start9 + + + + + + + + + + +
+

404

+

We cannot find what you are looking for!

+

+ Home +

+
+ + \ No newline at end of file diff --git a/docs/_build/dirhtml/404/index.html b/docs/_build/dirhtml/404/index.html new file mode 100644 index 0000000..4ab50e9 --- /dev/null +++ b/docs/_build/dirhtml/404/index.html @@ -0,0 +1,36 @@ + + + + + + + + + + Start9 + + + + + + + + + + +
+

404

+

We cannot find what you are looking for!

+

+ Home +

+
+ + \ No newline at end of file diff --git a/source/_static/images/ssl/windows/1_windows_mmc.png b/docs/_build/dirhtml/_images/1_windows_mmc.png similarity index 100% rename from source/_static/images/ssl/windows/1_windows_mmc.png rename to docs/_build/dirhtml/_images/1_windows_mmc.png diff --git a/source/_static/images/ssl/windows/2_windows_console_root.png b/docs/_build/dirhtml/_images/2_windows_console_root.png similarity index 100% rename from source/_static/images/ssl/windows/2_windows_console_root.png rename to docs/_build/dirhtml/_images/2_windows_console_root.png diff --git a/source/_static/images/ssl/windows/3_windows_add_certificates.png b/docs/_build/dirhtml/_images/3_windows_add_certificates.png similarity index 100% rename from source/_static/images/ssl/windows/3_windows_add_certificates.png rename to docs/_build/dirhtml/_images/3_windows_add_certificates.png diff --git a/source/_static/images/ssl/windows/4_windows_selected_snapin.png b/docs/_build/dirhtml/_images/4_windows_selected_snapin.png similarity index 100% rename from source/_static/images/ssl/windows/4_windows_selected_snapin.png rename to docs/_build/dirhtml/_images/4_windows_selected_snapin.png diff --git a/source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.png b/docs/_build/dirhtml/_images/5_windows_trusted_certificate_menu.png similarity index 100% rename from source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.png rename to docs/_build/dirhtml/_images/5_windows_trusted_certificate_menu.png diff --git a/source/_static/images/ssl/windows/6_windows_import_cert.png b/docs/_build/dirhtml/_images/6_windows_import_cert.png similarity index 100% rename from source/_static/images/ssl/windows/6_windows_import_cert.png rename to docs/_build/dirhtml/_images/6_windows_import_cert.png diff --git a/source/_static/images/ssl/windows/7_windows_import_cert_wizard.png b/docs/_build/dirhtml/_images/7_windows_import_cert_wizard.png similarity index 100% rename from source/_static/images/ssl/windows/7_windows_import_cert_wizard.png rename to docs/_build/dirhtml/_images/7_windows_import_cert_wizard.png diff --git a/source/_static/images/ssl/windows/8_windows_successful_cert_install.png b/docs/_build/dirhtml/_images/8_windows_successful_cert_install.png similarity index 100% rename from source/_static/images/ssl/windows/8_windows_successful_cert_install.png rename to docs/_build/dirhtml/_images/8_windows_successful_cert_install.png diff --git a/source/_static/images/tor/about_config.png b/docs/_build/dirhtml/_images/about_config.png similarity index 100% rename from source/_static/images/tor/about_config.png rename to docs/_build/dirhtml/_images/about_config.png diff --git a/source/_static/images/ssl/macos/always_trust.png b/docs/_build/dirhtml/_images/always_trust.png similarity index 100% rename from source/_static/images/ssl/macos/always_trust.png rename to docs/_build/dirhtml/_images/always_trust.png diff --git a/source/_static/images/tor/autoconfig_url.png b/docs/_build/dirhtml/_images/autoconfig_url.png similarity index 100% rename from source/_static/images/tor/autoconfig_url.png rename to docs/_build/dirhtml/_images/autoconfig_url.png diff --git a/source/_static/images/backup_warning.png b/docs/_build/dirhtml/_images/backup_warning.png similarity index 100% rename from source/_static/images/backup_warning.png rename to docs/_build/dirhtml/_images/backup_warning.png diff --git a/source/_static/images/diy/balena.png b/docs/_build/dirhtml/_images/balena.png similarity index 100% rename from source/_static/images/diy/balena.png rename to docs/_build/dirhtml/_images/balena.png diff --git a/source/_static/images/bitcoin_backup_view_no_storage.png b/docs/_build/dirhtml/_images/bitcoin_backup_view_no_storage.png similarity index 100% rename from source/_static/images/bitcoin_backup_view_no_storage.png rename to docs/_build/dirhtml/_images/bitcoin_backup_view_no_storage.png diff --git a/source/_static/images/bitcoin_backup_view_storage.png b/docs/_build/dirhtml/_images/bitcoin_backup_view_storage.png similarity index 100% rename from source/_static/images/bitcoin_backup_view_storage.png rename to docs/_build/dirhtml/_images/bitcoin_backup_view_storage.png diff --git a/source/_static/images/service/bitcoin_config.png b/docs/_build/dirhtml/_images/bitcoin_config.png similarity index 100% rename from source/_static/images/service/bitcoin_config.png rename to docs/_build/dirhtml/_images/bitcoin_config.png diff --git a/source/_static/images/bitcoin_creating_backup.png b/docs/_build/dirhtml/_images/bitcoin_creating_backup.png similarity index 100% rename from source/_static/images/bitcoin_creating_backup.png rename to docs/_build/dirhtml/_images/bitcoin_creating_backup.png diff --git a/source/_static/images/service/bitcoin_instructions.png b/docs/_build/dirhtml/_images/bitcoin_instructions.png similarity index 100% rename from source/_static/images/service/bitcoin_instructions.png rename to docs/_build/dirhtml/_images/bitcoin_instructions.png diff --git a/source/_static/images/bitcoin_instructions.png b/docs/_build/dirhtml/_images/bitcoin_instructions1.png similarity index 100% rename from source/_static/images/bitcoin_instructions.png rename to docs/_build/dirhtml/_images/bitcoin_instructions1.png diff --git a/source/_static/images/bitcoin_instructions_view.png b/docs/_build/dirhtml/_images/bitcoin_instructions_view.png similarity index 100% rename from source/_static/images/bitcoin_instructions_view.png rename to docs/_build/dirhtml/_images/bitcoin_instructions_view.png diff --git a/source/_static/images/bitcoin_view.png b/docs/_build/dirhtml/_images/bitcoin_view.png similarity index 100% rename from source/_static/images/bitcoin_view.png rename to docs/_build/dirhtml/_images/bitcoin_view.png diff --git a/source/_static/images/service/boolean_toggle.png b/docs/_build/dirhtml/_images/boolean_toggle.png similarity index 100% rename from source/_static/images/service/boolean_toggle.png rename to docs/_build/dirhtml/_images/boolean_toggle.png diff --git a/source/_static/images/ssl/browser/brave_security_settings.png b/docs/_build/dirhtml/_images/brave_security_settings.png similarity index 100% rename from source/_static/images/ssl/browser/brave_security_settings.png rename to docs/_build/dirhtml/_images/brave_security_settings.png diff --git a/source/_static/images/ssl/browser/brave_view_certs.png b/docs/_build/dirhtml/_images/brave_view_certs.png similarity index 100% rename from source/_static/images/ssl/browser/brave_view_certs.png rename to docs/_build/dirhtml/_images/brave_view_certs.png diff --git a/source/_static/images/ssl/macos/certificate_trusted.png b/docs/_build/dirhtml/_images/certificate_trusted.png similarity index 100% rename from source/_static/images/ssl/macos/certificate_trusted.png rename to docs/_build/dirhtml/_images/certificate_trusted.png diff --git a/source/_static/images/ssl/macos/certificate_untrusted.png b/docs/_build/dirhtml/_images/certificate_untrusted.png similarity index 100% rename from source/_static/images/ssl/macos/certificate_untrusted.png rename to docs/_build/dirhtml/_images/certificate_untrusted.png diff --git a/source/_static/images/decrypt_backup.png b/docs/_build/dirhtml/_images/decrypt_backup.png similarity index 100% rename from source/_static/images/decrypt_backup.png rename to docs/_build/dirhtml/_images/decrypt_backup.png diff --git a/source/_static/images/embassy_auto_check_updates.png b/docs/_build/dirhtml/_images/embassy_auto_check_updates.png similarity index 100% rename from source/_static/images/embassy_auto_check_updates.png rename to docs/_build/dirhtml/_images/embassy_auto_check_updates.png diff --git a/source/_static/images/embassy_config.png b/docs/_build/dirhtml/_images/embassy_config.png similarity index 100% rename from source/_static/images/embassy_config.png rename to docs/_build/dirhtml/_images/embassy_config.png diff --git a/source/_static/images/embassy_lan_setup.png b/docs/_build/dirhtml/_images/embassy_lan_setup.png similarity index 100% rename from source/_static/images/embassy_lan_setup.png rename to docs/_build/dirhtml/_images/embassy_lan_setup.png diff --git a/source/_static/images/embassy_notification.png b/docs/_build/dirhtml/_images/embassy_notification.png similarity index 100% rename from source/_static/images/embassy_notification.png rename to docs/_build/dirhtml/_images/embassy_notification.png diff --git a/source/_static/images/embassy_notifications.png b/docs/_build/dirhtml/_images/embassy_notifications.png similarity index 100% rename from source/_static/images/embassy_notifications.png rename to docs/_build/dirhtml/_images/embassy_notifications.png diff --git a/source/_static/images/embassy_wifi.png b/docs/_build/dirhtml/_images/embassy_wifi.png similarity index 100% rename from source/_static/images/embassy_wifi.png rename to docs/_build/dirhtml/_images/embassy_wifi.png diff --git a/source/_static/images/tor/firefox_options_windows.png b/docs/_build/dirhtml/_images/firefox_options_windows.png similarity index 100% rename from source/_static/images/tor/firefox_options_windows.png rename to docs/_build/dirhtml/_images/firefox_options_windows.png diff --git a/source/_static/images/tor/firefox_proxy.png b/docs/_build/dirhtml/_images/firefox_proxy.png similarity index 100% rename from source/_static/images/tor/firefox_proxy.png rename to docs/_build/dirhtml/_images/firefox_proxy.png diff --git a/source/_static/images/tor/firefox_search.png b/docs/_build/dirhtml/_images/firefox_search.png similarity index 100% rename from source/_static/images/tor/firefox_search.png rename to docs/_build/dirhtml/_images/firefox_search.png diff --git a/source/_static/images/ssl/browser/firefox_security_settings.png b/docs/_build/dirhtml/_images/firefox_security_settings.png similarity index 100% rename from source/_static/images/ssl/browser/firefox_security_settings.png rename to docs/_build/dirhtml/_images/firefox_security_settings.png diff --git a/source/_static/images/tor/firefox_whitelist.png b/docs/_build/dirhtml/_images/firefox_whitelist.png similarity index 100% rename from source/_static/images/tor/firefox_whitelist.png rename to docs/_build/dirhtml/_images/firefox_whitelist.png diff --git a/source/_static/images/tor/firefox_whitelist_mobile.png b/docs/_build/dirhtml/_images/firefox_whitelist_mobile.png similarity index 100% rename from source/_static/images/tor/firefox_whitelist_mobile.png rename to docs/_build/dirhtml/_images/firefox_whitelist_mobile.png diff --git a/source/_static/images/tor/install_homebrew.png b/docs/_build/dirhtml/_images/install_homebrew.png similarity index 100% rename from source/_static/images/tor/install_homebrew.png rename to docs/_build/dirhtml/_images/install_homebrew.png diff --git a/source/_static/images/tor/install_homebrew1.png b/docs/_build/dirhtml/_images/install_homebrew1.png similarity index 100% rename from source/_static/images/tor/install_homebrew1.png rename to docs/_build/dirhtml/_images/install_homebrew1.png diff --git a/source/_static/images/tor/install_tor.png b/docs/_build/dirhtml/_images/install_tor.png similarity index 100% rename from source/_static/images/tor/install_tor.png rename to docs/_build/dirhtml/_images/install_tor.png diff --git a/source/_static/images/tor/network_proxy_type.png b/docs/_build/dirhtml/_images/network_proxy_type.png similarity index 100% rename from source/_static/images/tor/network_proxy_type.png rename to docs/_build/dirhtml/_images/network_proxy_type.png diff --git a/source/_static/images/tor/orbot_apps.png b/docs/_build/dirhtml/_images/orbot_apps.png similarity index 100% rename from source/_static/images/tor/orbot_apps.png rename to docs/_build/dirhtml/_images/orbot_apps.png diff --git a/source/_static/images/tor/orbot_menu.png b/docs/_build/dirhtml/_images/orbot_menu.png similarity index 100% rename from source/_static/images/tor/orbot_menu.png rename to docs/_build/dirhtml/_images/orbot_menu.png diff --git a/source/_static/images/tor/orbot_settings.png b/docs/_build/dirhtml/_images/orbot_settings.png similarity index 100% rename from source/_static/images/tor/orbot_settings.png rename to docs/_build/dirhtml/_images/orbot_settings.png diff --git a/source/_static/images/tor/orbot_start.png b/docs/_build/dirhtml/_images/orbot_start.png similarity index 100% rename from source/_static/images/tor/orbot_start.png rename to docs/_build/dirhtml/_images/orbot_start.png diff --git a/source/_static/images/tor/orbot_started.png b/docs/_build/dirhtml/_images/orbot_started.png similarity index 100% rename from source/_static/images/tor/orbot_started.png rename to docs/_build/dirhtml/_images/orbot_started.png diff --git a/source/_static/images/tor/orbot_vpn.png b/docs/_build/dirhtml/_images/orbot_vpn.png similarity index 100% rename from source/_static/images/tor/orbot_vpn.png rename to docs/_build/dirhtml/_images/orbot_vpn.png diff --git a/source/_static/images/diy/pi.png b/docs/_build/dirhtml/_images/pi.png similarity index 100% rename from source/_static/images/diy/pi.png rename to docs/_build/dirhtml/_images/pi.png diff --git a/source/_static/images/diy/pins.png b/docs/_build/dirhtml/_images/pins.png similarity index 100% rename from source/_static/images/diy/pins.png rename to docs/_build/dirhtml/_images/pins.png diff --git a/source/_static/images/tor/private_dns_off.png b/docs/_build/dirhtml/_images/private_dns_off.png similarity index 100% rename from source/_static/images/tor/private_dns_off.png rename to docs/_build/dirhtml/_images/private_dns_off.png diff --git a/source/_static/images/restore_backup_menu.png b/docs/_build/dirhtml/_images/restore_backup_menu.png similarity index 100% rename from source/_static/images/restore_backup_menu.png rename to docs/_build/dirhtml/_images/restore_backup_menu.png diff --git a/source/_static/images/restore_backup_submenu.png b/docs/_build/dirhtml/_images/restore_backup_submenu.png similarity index 100% rename from source/_static/images/restore_backup_submenu.png rename to docs/_build/dirhtml/_images/restore_backup_submenu.png diff --git a/source/_static/images/restoring_backup.png b/docs/_build/dirhtml/_images/restoring_backup.png similarity index 100% rename from source/_static/images/restoring_backup.png rename to docs/_build/dirhtml/_images/restoring_backup.png diff --git a/source/_static/images/secure_lan_setup_page.png b/docs/_build/dirhtml/_images/secure_lan_setup_page.png similarity index 100% rename from source/_static/images/secure_lan_setup_page.png rename to docs/_build/dirhtml/_images/secure_lan_setup_page.png diff --git a/source/_static/images/secure_lan_setup_prompt.png b/docs/_build/dirhtml/_images/secure_lan_setup_prompt.png similarity index 100% rename from source/_static/images/secure_lan_setup_prompt.png rename to docs/_build/dirhtml/_images/secure_lan_setup_prompt.png diff --git a/source/_static/images/service/service_properties.png b/docs/_build/dirhtml/_images/service_properties.png similarity index 100% rename from source/_static/images/service/service_properties.png rename to docs/_build/dirhtml/_images/service_properties.png diff --git a/source/_static/images/tor/socks_remote_dns.png b/docs/_build/dirhtml/_images/socks_remote_dns.png similarity index 100% rename from source/_static/images/tor/socks_remote_dns.png rename to docs/_build/dirhtml/_images/socks_remote_dns.png diff --git a/source/_static/images/ssl/mobile/ssl_certificate_install_page.PNG b/docs/_build/dirhtml/_images/ssl_certificate_install_page.png similarity index 100% rename from source/_static/images/ssl/mobile/ssl_certificate_install_page.PNG rename to docs/_build/dirhtml/_images/ssl_certificate_install_page.png diff --git a/source/_static/images/ssl/mobile/ssl_ipad_cert_trust.PNG b/docs/_build/dirhtml/_images/ssl_ipad_cert_trust.png similarity index 100% rename from source/_static/images/ssl/mobile/ssl_ipad_cert_trust.PNG rename to docs/_build/dirhtml/_images/ssl_ipad_cert_trust.png diff --git a/source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.PNG b/docs/_build/dirhtml/_images/ssl_ipad_cert_trust_settings.png similarity index 100% rename from source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.PNG rename to docs/_build/dirhtml/_images/ssl_ipad_cert_trust_settings.png diff --git a/source/_static/images/ssl/mobile/ssl_ipad_general_settings.PNG b/docs/_build/dirhtml/_images/ssl_ipad_general_settings.png similarity index 100% rename from source/_static/images/ssl/mobile/ssl_ipad_general_settings.PNG rename to docs/_build/dirhtml/_images/ssl_ipad_general_settings.png diff --git a/source/_static/images/ssl/mobile/ssl_ipad_install_profile.PNG b/docs/_build/dirhtml/_images/ssl_ipad_install_profile.png similarity index 100% rename from source/_static/images/ssl/mobile/ssl_ipad_install_profile.PNG rename to docs/_build/dirhtml/_images/ssl_ipad_install_profile.png diff --git a/source/_static/images/ssl/mobile/ssl_ipad_profiles.PNG b/docs/_build/dirhtml/_images/ssl_ipad_profiles.png similarity index 100% rename from source/_static/images/ssl/mobile/ssl_ipad_profiles.PNG rename to docs/_build/dirhtml/_images/ssl_ipad_profiles.png diff --git a/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG b/docs/_build/dirhtml/_images/ssl_setup_app_advanced.png similarity index 100% rename from source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG rename to docs/_build/dirhtml/_images/ssl_setup_app_advanced.png diff --git a/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG b/docs/_build/dirhtml/_images/ssl_setup_app_complete.png similarity index 100% rename from source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG rename to docs/_build/dirhtml/_images/ssl_setup_app_complete.png diff --git a/source/_static/images/tor/tor_download_windows.png b/docs/_build/dirhtml/_images/tor_download_windows.png similarity index 100% rename from source/_static/images/tor/tor_download_windows.png rename to docs/_build/dirhtml/_images/tor_download_windows.png diff --git a/source/_static/images/tor/tor_windows_install.png b/docs/_build/dirhtml/_images/tor_windows_install.png similarity index 100% rename from source/_static/images/tor/tor_windows_install.png rename to docs/_build/dirhtml/_images/tor_windows_install.png diff --git a/source/_static/images/tor/tor_windows_terminal.png b/docs/_build/dirhtml/_images/tor_windows_terminal.png similarity index 100% rename from source/_static/images/tor/tor_windows_terminal.png rename to docs/_build/dirhtml/_images/tor_windows_terminal.png diff --git a/source/_static/images/ssl/windows/windows_download_cert.png b/docs/_build/dirhtml/_images/windows_download_cert.png similarity index 100% rename from source/_static/images/ssl/windows/windows_download_cert.png rename to docs/_build/dirhtml/_images/windows_download_cert.png diff --git a/source/contributing/embassyos.rst b/docs/_build/dirhtml/_sources/contributing/embassyos.rst.txt similarity index 100% rename from source/contributing/embassyos.rst rename to docs/_build/dirhtml/_sources/contributing/embassyos.rst.txt diff --git a/source/contributing/services/backups.rst b/docs/_build/dirhtml/_sources/contributing/services/backups.rst.txt similarity index 100% rename from source/contributing/services/backups.rst rename to docs/_build/dirhtml/_sources/contributing/services/backups.rst.txt diff --git a/source/contributing/services/config.rst b/docs/_build/dirhtml/_sources/contributing/services/config.rst.txt similarity index 100% rename from source/contributing/services/config.rst rename to docs/_build/dirhtml/_sources/contributing/services/config.rst.txt diff --git a/source/contributing/services/docker.rst b/docs/_build/dirhtml/_sources/contributing/services/docker.rst.txt similarity index 100% rename from source/contributing/services/docker.rst rename to docs/_build/dirhtml/_sources/contributing/services/docker.rst.txt diff --git a/source/contributing/services/index.rst b/docs/_build/dirhtml/_sources/contributing/services/index.rst.txt similarity index 100% rename from source/contributing/services/index.rst rename to docs/_build/dirhtml/_sources/contributing/services/index.rst.txt diff --git a/source/contributing/services/instructions.rst b/docs/_build/dirhtml/_sources/contributing/services/instructions.rst.txt similarity index 100% rename from source/contributing/services/instructions.rst rename to docs/_build/dirhtml/_sources/contributing/services/instructions.rst.txt diff --git a/source/contributing/services/makefile.rst b/docs/_build/dirhtml/_sources/contributing/services/makefile.rst.txt similarity index 100% rename from source/contributing/services/makefile.rst rename to docs/_build/dirhtml/_sources/contributing/services/makefile.rst.txt diff --git a/source/contributing/services/manifest.rst b/docs/_build/dirhtml/_sources/contributing/services/manifest.rst.txt similarity index 100% rename from source/contributing/services/manifest.rst rename to docs/_build/dirhtml/_sources/contributing/services/manifest.rst.txt diff --git a/source/contributing/services/overview.rst b/docs/_build/dirhtml/_sources/contributing/services/overview.rst.txt similarity index 100% rename from source/contributing/services/overview.rst rename to docs/_build/dirhtml/_sources/contributing/services/overview.rst.txt diff --git a/source/contributing/services/properties.rst b/docs/_build/dirhtml/_sources/contributing/services/properties.rst.txt similarity index 100% rename from source/contributing/services/properties.rst rename to docs/_build/dirhtml/_sources/contributing/services/properties.rst.txt diff --git a/source/contributing/services/wrapper.rst b/docs/_build/dirhtml/_sources/contributing/services/wrapper.rst.txt similarity index 100% rename from source/contributing/services/wrapper.rst rename to docs/_build/dirhtml/_sources/contributing/services/wrapper.rst.txt diff --git a/source/getting-started/diy.rst b/docs/_build/dirhtml/_sources/getting-started/diy.rst.txt similarity index 100% rename from source/getting-started/diy.rst rename to docs/_build/dirhtml/_sources/getting-started/diy.rst.txt diff --git a/source/getting-started/introduction.rst b/docs/_build/dirhtml/_sources/getting-started/introduction.rst.txt similarity index 100% rename from source/getting-started/introduction.rst rename to docs/_build/dirhtml/_sources/getting-started/introduction.rst.txt diff --git a/source/getting-started/purchasing.rst b/docs/_build/dirhtml/_sources/getting-started/purchasing.rst.txt similarity index 100% rename from source/getting-started/purchasing.rst rename to docs/_build/dirhtml/_sources/getting-started/purchasing.rst.txt diff --git a/docs/_build/dirhtml/_sources/index.rst.txt b/docs/_build/dirhtml/_sources/index.rst.txt new file mode 100644 index 0000000..38c1637 --- /dev/null +++ b/docs/_build/dirhtml/_sources/index.rst.txt @@ -0,0 +1,132 @@ +.. title:: Start9 Documentation + +.. raw:: html + +
+ +.. hero-box:: + :title: Welcome to the Start9 Documentation + :button_icon: scylla-icon scylla-icon--monitoring + :button_url: https://docs.start9.com/getting-started/introduction/ + :button_text: Start here + :image: /_static/img/icons/docs_info.png + + Here you will find guidance and information about the Start9 Embassy personal server and its operating system, EmbassyOS. + +.. raw:: html + +
+ +.. raw:: html + +
+ +
+ +.. topic-box:: + :title: Purchasing + :link: getting-started/purchasing + :icon: scylla-icon scylla-icon--bitcoin + :class: large-6 + :anchor: Learn more + + Learn about how you can purchase Start9 products. + +.. topic-box:: + :title: Videos + :link: https://www.youtube.com/channel/UCGEw4HJDvOn3Oy8ykR36P7Q + :icon: scylla-icon scylla-icon--webinars + :class: large-6 + :anchor: Learn more + + Check out our how to and informational videos. + +.. topic-box:: + :title: Support + :link: support + :icon: scylla-icon scylla-icon--support + :class: large-6 + :anchor: Learn more + + Read our FAQ and learn about platform concepts. + +.. topic-box:: + :title: DIY + :link: getting-started/diy + :icon: scylla-icon scylla-icon--integrations + :class: large-6 + :anchor: Learn more + + Get started yourself with our Do It Yourself guide + +.. topic-box:: + :title: About + :link: about + :icon: scylla-icon scylla-icon--about-team + :class: large-6 + :anchor: Learn more + + Explore Start9's mission and philosophy. + +.. topic-box:: + :title: Contribute + :link: contributing + :icon: scylla-icon scylla-icon--apps + :class: large-6 + :anchor: Learn more + + Learn about developing for EmbassyOS or contribute to packing services for the marketplace. + +.. raw:: html + +
+ +.. raw:: html + +
+ +.. toctree:: + :maxdepth: 2 + :caption: Getting Started + :hidden: + + getting-started/introduction + getting-started/purchasing + getting-started/diy + +.. toctree:: + :maxdepth: 2 + :caption: User Manual + :hidden: + + user-manual/initial-setup + user-manual/connecting + user-manual/general/index + user-manual/managing-services/index + +.. toctree:: + :maxdepth: 2 + :caption: Misc Guides + :hidden: + + misc-guides/available-services + misc-guides/bitcoin-cli + misc-guides/tor-os/index + misc-guides/tor-firefox/index + +.. toctree:: + :maxdepth: 2 + :caption: Contributing + :hidden: + + contributing/services/index + contributing/embassyos + +.. toctree:: + :maxdepth: 2 + :caption: Support + :hidden: + + support/FAQ/index + support/concepts + support/contact \ No newline at end of file diff --git a/source/misc-guides/available-services.rst b/docs/_build/dirhtml/_sources/misc-guides/available-services.rst.txt similarity index 100% rename from source/misc-guides/available-services.rst rename to docs/_build/dirhtml/_sources/misc-guides/available-services.rst.txt diff --git a/source/misc-guides/bitcoin-cli.rst b/docs/_build/dirhtml/_sources/misc-guides/bitcoin-cli.rst.txt similarity index 100% rename from source/misc-guides/bitcoin-cli.rst rename to docs/_build/dirhtml/_sources/misc-guides/bitcoin-cli.rst.txt diff --git a/source/misc-guides/tor-firefox/android.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-firefox/android.rst.txt similarity index 100% rename from source/misc-guides/tor-firefox/android.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-firefox/android.rst.txt diff --git a/source/misc-guides/tor-firefox/desktop.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-firefox/desktop.rst.txt similarity index 100% rename from source/misc-guides/tor-firefox/desktop.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-firefox/desktop.rst.txt diff --git a/source/misc-guides/tor-firefox/index.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-firefox/index.rst.txt similarity index 100% rename from source/misc-guides/tor-firefox/index.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-firefox/index.rst.txt diff --git a/source/misc-guides/tor-firefox/ios.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-firefox/ios.rst.txt similarity index 100% rename from source/misc-guides/tor-firefox/ios.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-firefox/ios.rst.txt diff --git a/source/misc-guides/tor-firefox/mobile.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-firefox/mobile.rst.txt similarity index 100% rename from source/misc-guides/tor-firefox/mobile.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-firefox/mobile.rst.txt diff --git a/source/misc-guides/tor-os/android.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-os/android.rst.txt similarity index 100% rename from source/misc-guides/tor-os/android.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-os/android.rst.txt diff --git a/source/misc-guides/tor-os/index.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-os/index.rst.txt similarity index 100% rename from source/misc-guides/tor-os/index.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-os/index.rst.txt diff --git a/source/misc-guides/tor-os/ios.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-os/ios.rst.txt similarity index 100% rename from source/misc-guides/tor-os/ios.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-os/ios.rst.txt diff --git a/source/misc-guides/tor-os/linux.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-os/linux.rst.txt similarity index 100% rename from source/misc-guides/tor-os/linux.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-os/linux.rst.txt diff --git a/source/misc-guides/tor-os/mac.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-os/mac.rst.txt similarity index 100% rename from source/misc-guides/tor-os/mac.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-os/mac.rst.txt diff --git a/source/misc-guides/tor-os/windows.rst b/docs/_build/dirhtml/_sources/misc-guides/tor-os/windows.rst.txt similarity index 100% rename from source/misc-guides/tor-os/windows.rst rename to docs/_build/dirhtml/_sources/misc-guides/tor-os/windows.rst.txt diff --git a/source/support/FAQ/030-faq.rst b/docs/_build/dirhtml/_sources/support/FAQ/030-faq.rst.txt similarity index 100% rename from source/support/FAQ/030-faq.rst rename to docs/_build/dirhtml/_sources/support/FAQ/030-faq.rst.txt diff --git a/source/support/FAQ/bitcoin-faq.rst b/docs/_build/dirhtml/_sources/support/FAQ/bitcoin-faq.rst.txt similarity index 100% rename from source/support/FAQ/bitcoin-faq.rst rename to docs/_build/dirhtml/_sources/support/FAQ/bitcoin-faq.rst.txt diff --git a/source/support/FAQ/dev-faq.rst b/docs/_build/dirhtml/_sources/support/FAQ/dev-faq.rst.txt similarity index 100% rename from source/support/FAQ/dev-faq.rst rename to docs/_build/dirhtml/_sources/support/FAQ/dev-faq.rst.txt diff --git a/source/support/FAQ/embassy-faq.rst b/docs/_build/dirhtml/_sources/support/FAQ/embassy-faq.rst.txt similarity index 100% rename from source/support/FAQ/embassy-faq.rst rename to docs/_build/dirhtml/_sources/support/FAQ/embassy-faq.rst.txt diff --git a/source/support/FAQ/general-faq.rst b/docs/_build/dirhtml/_sources/support/FAQ/general-faq.rst.txt similarity index 100% rename from source/support/FAQ/general-faq.rst rename to docs/_build/dirhtml/_sources/support/FAQ/general-faq.rst.txt diff --git a/source/support/FAQ/index.rst b/docs/_build/dirhtml/_sources/support/FAQ/index.rst.txt similarity index 100% rename from source/support/FAQ/index.rst rename to docs/_build/dirhtml/_sources/support/FAQ/index.rst.txt diff --git a/source/support/FAQ/services-faq.rst b/docs/_build/dirhtml/_sources/support/FAQ/services-faq.rst.txt similarity index 100% rename from source/support/FAQ/services-faq.rst rename to docs/_build/dirhtml/_sources/support/FAQ/services-faq.rst.txt diff --git a/source/support/FAQ/setup-faq.rst b/docs/_build/dirhtml/_sources/support/FAQ/setup-faq.rst.txt similarity index 100% rename from source/support/FAQ/setup-faq.rst rename to docs/_build/dirhtml/_sources/support/FAQ/setup-faq.rst.txt diff --git a/source/support/FAQ/usage-faq.rst b/docs/_build/dirhtml/_sources/support/FAQ/usage-faq.rst.txt similarity index 100% rename from source/support/FAQ/usage-faq.rst rename to docs/_build/dirhtml/_sources/support/FAQ/usage-faq.rst.txt diff --git a/source/support/concepts.rst b/docs/_build/dirhtml/_sources/support/concepts.rst.txt similarity index 100% rename from source/support/concepts.rst rename to docs/_build/dirhtml/_sources/support/concepts.rst.txt diff --git a/source/support/contact.rst b/docs/_build/dirhtml/_sources/support/contact.rst.txt similarity index 100% rename from source/support/contact.rst rename to docs/_build/dirhtml/_sources/support/contact.rst.txt diff --git a/source/user-manual/connecting.rst b/docs/_build/dirhtml/_sources/user-manual/connecting.rst.txt similarity index 100% rename from source/user-manual/connecting.rst rename to docs/_build/dirhtml/_sources/user-manual/connecting.rst.txt diff --git a/source/user-manual/general/developer-options/alt-marketplace.rst b/docs/_build/dirhtml/_sources/user-manual/general/developer-options/alt-marketplace.rst.txt similarity index 100% rename from source/user-manual/general/developer-options/alt-marketplace.rst rename to docs/_build/dirhtml/_sources/user-manual/general/developer-options/alt-marketplace.rst.txt diff --git a/source/user-manual/general/developer-options/index.rst b/docs/_build/dirhtml/_sources/user-manual/general/developer-options/index.rst.txt similarity index 100% rename from source/user-manual/general/developer-options/index.rst rename to docs/_build/dirhtml/_sources/user-manual/general/developer-options/index.rst.txt diff --git a/source/user-manual/general/developer-options/ssh-setup.rst b/docs/_build/dirhtml/_sources/user-manual/general/developer-options/ssh-setup.rst.txt similarity index 100% rename from source/user-manual/general/developer-options/ssh-setup.rst rename to docs/_build/dirhtml/_sources/user-manual/general/developer-options/ssh-setup.rst.txt diff --git a/source/user-manual/general/embassy-config.rst b/docs/_build/dirhtml/_sources/user-manual/general/embassy-config.rst.txt similarity index 100% rename from source/user-manual/general/embassy-config.rst rename to docs/_build/dirhtml/_sources/user-manual/general/embassy-config.rst.txt diff --git a/source/user-manual/general/forgot-password.rst b/docs/_build/dirhtml/_sources/user-manual/general/forgot-password.rst.txt similarity index 100% rename from source/user-manual/general/forgot-password.rst rename to docs/_build/dirhtml/_sources/user-manual/general/forgot-password.rst.txt diff --git a/source/user-manual/general/index.rst b/docs/_build/dirhtml/_sources/user-manual/general/index.rst.txt similarity index 100% rename from source/user-manual/general/index.rst rename to docs/_build/dirhtml/_sources/user-manual/general/index.rst.txt diff --git a/source/user-manual/general/lan-setup/browser-setup.rst b/docs/_build/dirhtml/_sources/user-manual/general/lan-setup/browser-setup.rst.txt similarity index 100% rename from source/user-manual/general/lan-setup/browser-setup.rst rename to docs/_build/dirhtml/_sources/user-manual/general/lan-setup/browser-setup.rst.txt diff --git a/source/user-manual/general/lan-setup/computer-setup.rst b/docs/_build/dirhtml/_sources/user-manual/general/lan-setup/computer-setup.rst.txt similarity index 100% rename from source/user-manual/general/lan-setup/computer-setup.rst rename to docs/_build/dirhtml/_sources/user-manual/general/lan-setup/computer-setup.rst.txt diff --git a/source/user-manual/general/lan-setup/desktop.rst b/docs/_build/dirhtml/_sources/user-manual/general/lan-setup/desktop.rst.txt similarity index 100% rename from source/user-manual/general/lan-setup/desktop.rst rename to docs/_build/dirhtml/_sources/user-manual/general/lan-setup/desktop.rst.txt diff --git a/source/user-manual/general/lan-setup/index.rst b/docs/_build/dirhtml/_sources/user-manual/general/lan-setup/index.rst.txt similarity index 100% rename from source/user-manual/general/lan-setup/index.rst rename to docs/_build/dirhtml/_sources/user-manual/general/lan-setup/index.rst.txt diff --git a/source/user-manual/general/lan-setup/mobile.rst b/docs/_build/dirhtml/_sources/user-manual/general/lan-setup/mobile.rst.txt similarity index 100% rename from source/user-manual/general/lan-setup/mobile.rst rename to docs/_build/dirhtml/_sources/user-manual/general/lan-setup/mobile.rst.txt diff --git a/source/user-manual/general/notifications.rst b/docs/_build/dirhtml/_sources/user-manual/general/notifications.rst.txt similarity index 100% rename from source/user-manual/general/notifications.rst rename to docs/_build/dirhtml/_sources/user-manual/general/notifications.rst.txt diff --git a/source/user-manual/general/power.rst b/docs/_build/dirhtml/_sources/user-manual/general/power.rst.txt similarity index 100% rename from source/user-manual/general/power.rst rename to docs/_build/dirhtml/_sources/user-manual/general/power.rst.txt diff --git a/source/user-manual/general/updating.rst b/docs/_build/dirhtml/_sources/user-manual/general/updating.rst.txt similarity index 100% rename from source/user-manual/general/updating.rst rename to docs/_build/dirhtml/_sources/user-manual/general/updating.rst.txt diff --git a/source/user-manual/general/wifi.rst b/docs/_build/dirhtml/_sources/user-manual/general/wifi.rst.txt similarity index 100% rename from source/user-manual/general/wifi.rst rename to docs/_build/dirhtml/_sources/user-manual/general/wifi.rst.txt diff --git a/source/user-manual/initial-setup.rst b/docs/_build/dirhtml/_sources/user-manual/initial-setup.rst.txt similarity index 100% rename from source/user-manual/initial-setup.rst rename to docs/_build/dirhtml/_sources/user-manual/initial-setup.rst.txt diff --git a/source/user-manual/managing-services/backups.rst b/docs/_build/dirhtml/_sources/user-manual/managing-services/backups.rst.txt similarity index 100% rename from source/user-manual/managing-services/backups.rst rename to docs/_build/dirhtml/_sources/user-manual/managing-services/backups.rst.txt diff --git a/source/user-manual/managing-services/index.rst b/docs/_build/dirhtml/_sources/user-manual/managing-services/index.rst.txt similarity index 100% rename from source/user-manual/managing-services/index.rst rename to docs/_build/dirhtml/_sources/user-manual/managing-services/index.rst.txt diff --git a/source/user-manual/managing-services/installing.rst b/docs/_build/dirhtml/_sources/user-manual/managing-services/installing.rst.txt similarity index 100% rename from source/user-manual/managing-services/installing.rst rename to docs/_build/dirhtml/_sources/user-manual/managing-services/installing.rst.txt diff --git a/source/user-manual/managing-services/instructions.rst b/docs/_build/dirhtml/_sources/user-manual/managing-services/instructions.rst.txt similarity index 100% rename from source/user-manual/managing-services/instructions.rst rename to docs/_build/dirhtml/_sources/user-manual/managing-services/instructions.rst.txt diff --git a/source/user-manual/managing-services/logs.rst b/docs/_build/dirhtml/_sources/user-manual/managing-services/logs.rst.txt similarity index 100% rename from source/user-manual/managing-services/logs.rst rename to docs/_build/dirhtml/_sources/user-manual/managing-services/logs.rst.txt diff --git a/source/user-manual/managing-services/managing-deps.rst b/docs/_build/dirhtml/_sources/user-manual/managing-services/managing-deps.rst.txt similarity index 100% rename from source/user-manual/managing-services/managing-deps.rst rename to docs/_build/dirhtml/_sources/user-manual/managing-services/managing-deps.rst.txt diff --git a/source/user-manual/managing-services/properties.rst b/docs/_build/dirhtml/_sources/user-manual/managing-services/properties.rst.txt similarity index 100% rename from source/user-manual/managing-services/properties.rst rename to docs/_build/dirhtml/_sources/user-manual/managing-services/properties.rst.txt diff --git a/source/user-manual/managing-services/service-config.rst b/docs/_build/dirhtml/_sources/user-manual/managing-services/service-config.rst.txt similarity index 100% rename from source/user-manual/managing-services/service-config.rst rename to docs/_build/dirhtml/_sources/user-manual/managing-services/service-config.rst.txt diff --git a/docs/_build/dirhtml/_static/basic.css b/docs/_build/dirhtml/_static/basic.css new file mode 100644 index 0000000..0119285 --- /dev/null +++ b/docs/_build/dirhtml/_static/basic.css @@ -0,0 +1,768 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > p:first-child, +td > p:first-child { + margin-top: 0px; +} + +th > p:last-child, +td > p:last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +li > p:first-child { + margin-top: 0px; +} + +li > p:last-child { + margin-bottom: 0px; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > p:first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +div.code-block-caption { + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +div.code-block-caption + div > div.highlight > pre { + margin-top: 0; +} + +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + padding: 1em 1em 0; +} + +div.literal-block-wrapper div.highlight { + margin: 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: relative; + left: 0px; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/_build/dirhtml/_static/clipboard.min.js b/docs/_build/dirhtml/_static/clipboard.min.js new file mode 100644 index 0000000..02c549e --- /dev/null +++ b/docs/_build/dirhtml/_static/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.4 + * https://zenorocha.github.io/clipboard.js + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return function(n){var o={};function r(t){if(o[t])return o[t].exports;var e=o[t]={i:t,l:!1,exports:{}};return n[t].call(e.exports,e,e.exports,r),e.l=!0,e.exports}return r.m=n,r.c=o,r.d=function(t,e,n){r.o(t,e)||Object.defineProperty(t,e,{enumerable:!0,get:n})},r.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return r.d(e,"a",e),e},r.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},r.p="",r(r.s=0)}([function(t,e,n){"use strict";var r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},i=function(){function o(t,e){for(var n=0;n