diff --git a/.gitignore b/.gitignore index ad4ad61..defb084 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,7 @@ .DS_Store .vscode/ -build/ build-send.sh -utils/deploy.sh \ No newline at end of file +site/_build +site/_utils/docsearch_config.json +site/_utils/docsearch_index.js +.env \ No newline at end of file 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..9280e26 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 `./site/` 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/make.bat b/make.bat deleted file mode 100644 index 6247f7e..0000000 --- a/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/poetry.lock b/poetry.lock new file mode 100644 index 0000000..05b6264 --- /dev/null +++ b/poetry.lock @@ -0,0 +1,987 @@ +[[package]] +name = "alabaster" +version = "0.7.12" +description = "A configurable sidebar-enabled Sphinx theme" +category = "main" +optional = false +python-versions = "*" + +[[package]] +name = "argh" +version = "0.26.2" +description = "An unobtrusive argparse wrapper with natural syntax" +category = "dev" +optional = false +python-versions = "*" + +[[package]] +name = "atomicwrites" +version = "1.4.0" +description = "Atomic file writes." +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" + +[[package]] +name = "attrs" +version = "21.4.0" +description = "Classes Without Boilerplate" +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" + +[package.extras] +dev = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "furo", "sphinx", "sphinx-notfound-page", "pre-commit", "cloudpickle"] +docs = ["furo", "sphinx", "zope.interface", "sphinx-notfound-page"] +tests = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "cloudpickle"] +tests_no_zope = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "cloudpickle"] + +[[package]] +name = "babel" +version = "2.9.1" +description = "Internationalization utilities" +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" + +[package.dependencies] +pytz = ">=2015.7" + +[[package]] +name = "beautifulsoup4" +version = "4.10.0" +description = "Screen-scraping library" +category = "main" +optional = false +python-versions = ">3.0.0" + +[package.dependencies] +soupsieve = ">1.2" + +[package.extras] +html5lib = ["html5lib"] +lxml = ["lxml"] + +[[package]] +name = "certifi" +version = "2021.10.8" +description = "Python package for providing Mozilla's CA Bundle." +category = "main" +optional = false +python-versions = "*" + +[[package]] +name = "charset-normalizer" +version = "2.0.9" +description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." +category = "main" +optional = false +python-versions = ">=3.5.0" + +[package.extras] +unicode_backport = ["unicodedata2"] + +[[package]] +name = "colorama" +version = "0.4.4" +description = "Cross-platform colored terminal text." +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" + +[[package]] +name = "commonmark" +version = "0.9.1" +description = "Python parser for the CommonMark Markdown spec" +category = "main" +optional = false +python-versions = "*" + +[package.extras] +test = ["flake8 (==3.7.8)", "hypothesis (==3.55.3)"] + +[[package]] +name = "docutils" +version = "0.16" +description = "Docutils -- Python Documentation Utilities" +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" + +[[package]] +name = "idna" +version = "3.3" +description = "Internationalized Domain Names in Applications (IDNA)" +category = "main" +optional = false +python-versions = ">=3.5" + +[[package]] +name = "imagesize" +version = "1.3.0" +description = "Getting image size from png/jpeg/jpeg2000/gif file" +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" + +[[package]] +name = "importlib-metadata" +version = "4.10.0" +description = "Read metadata from Python packages" +category = "dev" +optional = false +python-versions = ">=3.7" + +[package.dependencies] +typing-extensions = {version = ">=3.6.4", markers = "python_version < \"3.8\""} +zipp = ">=0.5" + +[package.extras] +docs = ["sphinx", "jaraco.packaging (>=8.2)", "rst.linker (>=1.9)"] +perf = ["ipython"] +testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "pytest-cov", "pytest-enabler (>=1.0.1)", "packaging", "pyfakefs", "flufl.flake8", "pytest-perf (>=0.9.2)", "pytest-black (>=0.3.7)", "pytest-mypy", "importlib-resources (>=1.3)"] + +[[package]] +name = "jinja2" +version = "3.0.3" +description = "A very fast and expressive template engine." +category = "main" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +MarkupSafe = ">=2.0" + +[package.extras] +i18n = ["Babel (>=2.7)"] + +[[package]] +name = "livereload" +version = "2.6.3" +description = "Python LiveReload is an awesome tool for web developers" +category = "dev" +optional = false +python-versions = "*" + +[package.dependencies] +six = "*" +tornado = {version = "*", markers = "python_version > \"2.7\""} + +[[package]] +name = "markupsafe" +version = "2.0.1" +description = "Safely add untrusted strings to HTML/XML markup." +category = "main" +optional = false +python-versions = ">=3.6" + +[[package]] +name = "more-itertools" +version = "8.12.0" +description = "More routines for operating on iterables, beyond itertools" +category = "dev" +optional = false +python-versions = ">=3.5" + +[[package]] +name = "packaging" +version = "21.3" +description = "Core utilities for Python packages" +category = "main" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +pyparsing = ">=2.0.2,<3.0.5 || >3.0.5" + +[[package]] +name = "pathtools" +version = "0.1.2" +description = "File system general utilities" +category = "dev" +optional = false +python-versions = "*" + +[[package]] +name = "pluggy" +version = "0.13.1" +description = "plugin and hook calling mechanisms for python" +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" + +[package.dependencies] +importlib-metadata = {version = ">=0.12", markers = "python_version < \"3.8\""} + +[package.extras] +dev = ["pre-commit", "tox"] + +[[package]] +name = "port-for" +version = "0.3.1" +description = "Utility that helps with local TCP ports managment. It can find an unused TCP localhost port and remember the association." +category = "dev" +optional = false +python-versions = "*" + +[[package]] +name = "py" +version = "1.11.0" +description = "library with cross-python path, ini-parsing, io, code, log facilities" +category = "dev" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" + +[[package]] +name = "pygments" +version = "2.2.0" +description = "Pygments is a syntax highlighting package written in Python." +category = "main" +optional = false +python-versions = "*" + +[[package]] +name = "pyparsing" +version = "3.0.6" +description = "Python parsing module" +category = "main" +optional = false +python-versions = ">=3.6" + +[package.extras] +diagrams = ["jinja2", "railroad-diagrams"] + +[[package]] +name = "pytest" +version = "5.4.3" +description = "pytest: simple powerful testing with Python" +category = "dev" +optional = false +python-versions = ">=3.5" + +[package.dependencies] +atomicwrites = {version = ">=1.0", markers = "sys_platform == \"win32\""} +attrs = ">=17.4.0" +colorama = {version = "*", markers = "sys_platform == \"win32\""} +importlib-metadata = {version = ">=0.12", markers = "python_version < \"3.8\""} +more-itertools = ">=4.0.0" +packaging = "*" +pluggy = ">=0.12,<1.0" +py = ">=1.5.0" +wcwidth = "*" + +[package.extras] +checkqa-mypy = ["mypy (==v0.761)"] +testing = ["argcomplete", "hypothesis (>=3.56)", "mock", "nose", "requests", "xmlschema"] + +[[package]] +name = "pytz" +version = "2021.3" +description = "World timezone definitions, modern and historical" +category = "main" +optional = false +python-versions = "*" + +[[package]] +name = "pyyaml" +version = "5.4.1" +description = "YAML parser and emitter for Python" +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*" + +[[package]] +name = "recommonmark" +version = "0.5.0" +description = "A docutils-compatibility bridge to CommonMark, enabling you to write CommonMark inside of Docutils & Sphinx projects." +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +commonmark = ">=0.7.3" +docutils = ">=0.11" +sphinx = ">=1.3.1" + +[[package]] +name = "requests" +version = "2.26.0" +description = "Python HTTP for Humans." +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*" + +[package.dependencies] +certifi = ">=2017.4.17" +charset-normalizer = {version = ">=2.0.0,<2.1.0", markers = "python_version >= \"3\""} +idna = {version = ">=2.5,<4", markers = "python_version >= \"3\""} +urllib3 = ">=1.21.1,<1.27" + +[package.extras] +socks = ["PySocks (>=1.5.6,!=1.5.7)", "win-inet-pton"] +use_chardet_on_py3 = ["chardet (>=3.0.2,<5)"] + +[[package]] +name = "six" +version = "1.16.0" +description = "Python 2 and 3 compatibility utilities" +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" + +[[package]] +name = "snowballstemmer" +version = "2.2.0" +description = "This package provides 29 stemmers for 28 languages generated from Snowball algorithms." +category = "main" +optional = false +python-versions = "*" + +[[package]] +name = "soupsieve" +version = "2.3.1" +description = "A modern CSS selector implementation for Beautiful Soup." +category = "main" +optional = false +python-versions = ">=3.6" + +[[package]] +name = "sphinx" +version = "2.4.5" +description = "Python documentation generator" +category = "main" +optional = false +python-versions = ">=3.5" + +[package.dependencies] +alabaster = ">=0.7,<0.8" +babel = ">=1.3,<2.0 || >2.0" +colorama = {version = ">=0.3.5", markers = "sys_platform == \"win32\""} +docutils = ">=0.12,<0.18" +imagesize = "*" +Jinja2 = ">=2.3" +packaging = "*" +Pygments = ">=2.0" +requests = ">=2.5.0" +snowballstemmer = ">=1.1" +sphinxcontrib-applehelp = "*" +sphinxcontrib-devhelp = "*" +sphinxcontrib-htmlhelp = "*" +sphinxcontrib-jsmath = "*" +sphinxcontrib-qthelp = "*" +sphinxcontrib-serializinghtml = "*" + +[package.extras] +docs = ["sphinxcontrib-websupport"] +test = ["pytest (<5.3.3)", "pytest-cov", "html5lib", "flake8 (>=3.5.0)", "flake8-import-order", "mypy (>=0.761)", "docutils-stubs"] + +[[package]] +name = "sphinx-autobuild" +version = "0.7.1" +description = "Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a livereload enabled web server." +category = "dev" +optional = false +python-versions = "*" + +[package.dependencies] +argh = ">=0.24.1" +livereload = ">=2.3.0" +pathtools = ">=0.1.2" +port-for = "0.3.1" +PyYAML = ">=3.10" +tornado = ">=3.2" +watchdog = ">=0.7.1" + +[[package]] +name = "sphinx-copybutton" +version = "0.2.12" +description = "Add a copy button to each of your code cells." +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +sphinx = ">=1.8" + +[package.extras] +code_style = ["flake8 (>=3.7.0,<3.8.0)", "black", "pre-commit (==1.17.0)"] + +[[package]] +name = "sphinx-multiversion-scylla" +version = "0.2.10" +description = "Add support for multiple versions to sphinx" +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +sphinx = ">=2.1" + +[[package]] +name = "sphinx-notfound-page" +version = "0.6" +description = "Sphinx extension to build a 404 page with absolute URLs" +category = "main" +optional = false +python-versions = "*" + +[[package]] +name = "sphinx-scylladb-theme" +version = "1.0.6" +description = "A Sphinx Theme for ScyllaDB documentation projects" +category = "main" +optional = false +python-versions = ">=3.7,<4.0" + +[package.dependencies] +beautifulsoup4 = ">=4.9.3,<5.0.0" +pyyaml = ">=5.3,<6.0" +recommonmark = "0.5.0" +Sphinx = ">=2.4.4,<3.0.0" +sphinx-copybutton = ">=0.2.8,<0.3.0" +sphinx-multiversion-scylla = ">=0.2.4,<0.3.0" +sphinx-notfound-page = ">=0.6,<0.7" +sphinx-tabs = ">=3.1.0,<4.0.0" + +[[package]] +name = "sphinx-sitemap" +version = "2.1.0" +description = "Sitemap generator for Sphinx" +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +six = "*" +sphinx = ">=1.2" + +[[package]] +name = "sphinx-tabs" +version = "3.2.0" +description = "Tabbed views for Sphinx" +category = "main" +optional = false +python-versions = "~=3.6" + +[package.dependencies] +docutils = ">=0.16.0,<0.17.0" +pygments = "*" +sphinx = ">=2,<5" + +[package.extras] +code_style = ["pre-commit (==2.13.0)"] +testing = ["coverage", "pytest (>=3.6,<4)", "pytest-cov", "pytest-regressions", "pygments", "sphinx-testing", "bs4", "rinohtype"] + +[[package]] +name = "sphinxcontrib-applehelp" +version = "1.0.2" +description = "sphinxcontrib-applehelp is a sphinx extension which outputs Apple help books" +category = "main" +optional = false +python-versions = ">=3.5" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-devhelp" +version = "1.0.2" +description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp document." +category = "main" +optional = false +python-versions = ">=3.5" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-htmlhelp" +version = "2.0.0" +description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" +category = "main" +optional = false +python-versions = ">=3.6" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest", "html5lib"] + +[[package]] +name = "sphinxcontrib-jsmath" +version = "1.0.1" +description = "A sphinx extension which renders display math in HTML via JavaScript" +category = "main" +optional = false +python-versions = ">=3.5" + +[package.extras] +test = ["pytest", "flake8", "mypy"] + +[[package]] +name = "sphinxcontrib-qthelp" +version = "1.0.3" +description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp document." +category = "main" +optional = false +python-versions = ">=3.5" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-serializinghtml" +version = "1.1.5" +description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)." +category = "main" +optional = false +python-versions = ">=3.5" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[[package]] +name = "sphinxcontrib-youtube" +version = "1.0.1" +description = "Sphinx \"youtube\" extension" +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +Sphinx = ">=0.6" + +[[package]] +name = "tornado" +version = "6.1" +description = "Tornado is a Python web framework and asynchronous networking library, originally developed at FriendFeed." +category = "dev" +optional = false +python-versions = ">= 3.5" + +[[package]] +name = "typing-extensions" +version = "4.0.1" +description = "Backported and Experimental Type Hints for Python 3.6+" +category = "dev" +optional = false +python-versions = ">=3.6" + +[[package]] +name = "urllib3" +version = "1.26.7" +description = "HTTP library with thread-safe connection pooling, file post, and more." +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <4" + +[package.extras] +brotli = ["brotlipy (>=0.6.0)"] +secure = ["pyOpenSSL (>=0.14)", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "certifi", "ipaddress"] +socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"] + +[[package]] +name = "watchdog" +version = "2.1.6" +description = "Filesystem events monitoring" +category = "dev" +optional = false +python-versions = ">=3.6" + +[package.extras] +watchmedo = ["PyYAML (>=3.10)"] + +[[package]] +name = "wcwidth" +version = "0.2.5" +description = "Measures the displayed width of unicode strings in a terminal" +category = "dev" +optional = false +python-versions = "*" + +[[package]] +name = "zipp" +version = "3.7.0" +description = "Backport of pathlib-compatible object wrapper for zip files" +category = "dev" +optional = false +python-versions = ">=3.7" + +[package.extras] +docs = ["sphinx", "jaraco.packaging (>=8.2)", "rst.linker (>=1.9)"] +testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "pytest-cov", "pytest-enabler (>=1.0.1)", "jaraco.itertools", "func-timeout", "pytest-black (>=0.3.7)", "pytest-mypy"] + +[metadata] +lock-version = "1.1" +python-versions = "^3.7" +content-hash = "cdb9b5f202d73225ed6db41520d9a915d9c1231b579ae081fde1391c166234e3" + +[metadata.files] +alabaster = [ + {file = "alabaster-0.7.12-py2.py3-none-any.whl", hash = "sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359"}, + {file = "alabaster-0.7.12.tar.gz", hash = "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02"}, +] +argh = [ + {file = "argh-0.26.2-py2.py3-none-any.whl", hash = "sha256:a9b3aaa1904eeb78e32394cd46c6f37ac0fb4af6dc488daa58971bdc7d7fcaf3"}, + {file = "argh-0.26.2.tar.gz", hash = "sha256:e9535b8c84dc9571a48999094fda7f33e63c3f1b74f3e5f3ac0105a58405bb65"}, +] +atomicwrites = [ + {file = "atomicwrites-1.4.0-py2.py3-none-any.whl", hash = "sha256:6d1784dea7c0c8d4a5172b6c620f40b6e4cbfdf96d783691f2e1302a7b88e197"}, + {file = "atomicwrites-1.4.0.tar.gz", hash = "sha256:ae70396ad1a434f9c7046fd2dd196fc04b12f9e91ffb859164193be8b6168a7a"}, +] +attrs = [ + {file = "attrs-21.4.0-py2.py3-none-any.whl", hash = "sha256:2d27e3784d7a565d36ab851fe94887c5eccd6a463168875832a1be79c82828b4"}, + {file = "attrs-21.4.0.tar.gz", hash = "sha256:626ba8234211db98e869df76230a137c4c40a12d72445c45d5f5b716f076e2fd"}, +] +babel = [ + {file = "Babel-2.9.1-py2.py3-none-any.whl", hash = "sha256:ab49e12b91d937cd11f0b67cb259a57ab4ad2b59ac7a3b41d6c06c0ac5b0def9"}, + {file = "Babel-2.9.1.tar.gz", hash = "sha256:bc0c176f9f6a994582230df350aa6e05ba2ebe4b3ac317eab29d9be5d2768da0"}, +] +beautifulsoup4 = [ + {file = "beautifulsoup4-4.10.0-py3-none-any.whl", hash = "sha256:9a315ce70049920ea4572a4055bc4bd700c940521d36fc858205ad4fcde149bf"}, + {file = "beautifulsoup4-4.10.0.tar.gz", hash = "sha256:c23ad23c521d818955a4151a67d81580319d4bf548d3d49f4223ae041ff98891"}, +] +certifi = [ + {file = "certifi-2021.10.8-py2.py3-none-any.whl", hash = "sha256:d62a0163eb4c2344ac042ab2bdf75399a71a2d8c7d47eac2e2ee91b9d6339569"}, + {file = "certifi-2021.10.8.tar.gz", hash = "sha256:78884e7c1d4b00ce3cea67b44566851c4343c120abd683433ce934a68ea58872"}, +] +charset-normalizer = [ + {file = "charset-normalizer-2.0.9.tar.gz", hash = "sha256:b0b883e8e874edfdece9c28f314e3dd5badf067342e42fb162203335ae61aa2c"}, + {file = "charset_normalizer-2.0.9-py3-none-any.whl", hash = "sha256:1eecaa09422db5be9e29d7fc65664e6c33bd06f9ced7838578ba40d58bdf3721"}, +] +colorama = [ + {file = "colorama-0.4.4-py2.py3-none-any.whl", hash = "sha256:9f47eda37229f68eee03b24b9748937c7dc3868f906e8ba69fbcbdd3bc5dc3e2"}, + {file = "colorama-0.4.4.tar.gz", hash = "sha256:5941b2b48a20143d2267e95b1c2a7603ce057ee39fd88e7329b0c292aa16869b"}, +] +commonmark = [ + {file = "commonmark-0.9.1-py2.py3-none-any.whl", hash = "sha256:da2f38c92590f83de410ba1a3cbceafbc74fee9def35f9251ba9a971d6d66fd9"}, + {file = "commonmark-0.9.1.tar.gz", hash = "sha256:452f9dc859be7f06631ddcb328b6919c67984aca654e5fefb3914d54691aed60"}, +] +docutils = [ + {file = "docutils-0.16-py2.py3-none-any.whl", hash = "sha256:0c5b78adfbf7762415433f5515cd5c9e762339e23369dbe8000d84a4bf4ab3af"}, + {file = "docutils-0.16.tar.gz", hash = "sha256:c2de3a60e9e7d07be26b7f2b00ca0309c207e06c100f9cc2a94931fc75a478fc"}, +] +idna = [ + {file = "idna-3.3-py3-none-any.whl", hash = "sha256:84d9dd047ffa80596e0f246e2eab0b391788b0503584e8945f2368256d2735ff"}, + {file = "idna-3.3.tar.gz", hash = "sha256:9d643ff0a55b762d5cdb124b8eaa99c66322e2157b69160bc32796e824360e6d"}, +] +imagesize = [ + {file = "imagesize-1.3.0-py2.py3-none-any.whl", hash = "sha256:1db2f82529e53c3e929e8926a1fa9235aa82d0bd0c580359c67ec31b2fddaa8c"}, + {file = "imagesize-1.3.0.tar.gz", hash = "sha256:cd1750d452385ca327479d45b64d9c7729ecf0b3969a58148298c77092261f9d"}, +] +importlib-metadata = [ + {file = "importlib_metadata-4.10.0-py3-none-any.whl", hash = "sha256:b7cf7d3fef75f1e4c80a96ca660efbd51473d7e8f39b5ab9210febc7809012a4"}, + {file = "importlib_metadata-4.10.0.tar.gz", hash = "sha256:92a8b58ce734b2a4494878e0ecf7d79ccd7a128b5fc6014c401e0b61f006f0f6"}, +] +jinja2 = [ + {file = "Jinja2-3.0.3-py3-none-any.whl", hash = "sha256:077ce6014f7b40d03b47d1f1ca4b0fc8328a692bd284016f806ed0eaca390ad8"}, + {file = "Jinja2-3.0.3.tar.gz", hash = "sha256:611bb273cd68f3b993fabdc4064fc858c5b47a973cb5aa7999ec1ba405c87cd7"}, +] +livereload = [ + {file = "livereload-2.6.3.tar.gz", hash = "sha256:776f2f865e59fde56490a56bcc6773b6917366bce0c267c60ee8aaf1a0959869"}, +] +markupsafe = [ + {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:d8446c54dc28c01e5a2dbac5a25f071f6653e6e40f3a8818e8b45d790fe6ef53"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:36bc903cbb393720fad60fc28c10de6acf10dc6cc883f3e24ee4012371399a38"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2d7d807855b419fc2ed3e631034685db6079889a1f01d5d9dac950f764da3dad"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:add36cb2dbb8b736611303cd3bfcee00afd96471b09cda130da3581cbdc56a6d"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:168cd0a3642de83558a5153c8bd34f175a9a6e7f6dc6384b9655d2697312a646"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:4dc8f9fb58f7364b63fd9f85013b780ef83c11857ae79f2feda41e270468dd9b"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:20dca64a3ef2d6e4d5d615a3fd418ad3bde77a47ec8a23d984a12b5b4c74491a"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:cdfba22ea2f0029c9261a4bd07e830a8da012291fbe44dc794e488b6c9bb353a"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-win32.whl", hash = "sha256:99df47edb6bda1249d3e80fdabb1dab8c08ef3975f69aed437cb69d0a5de1e28"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:e0f138900af21926a02425cf736db95be9f4af72ba1bb21453432a07f6082134"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:f9081981fe268bd86831e5c75f7de206ef275defcb82bc70740ae6dc507aee51"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:0955295dd5eec6cb6cc2fe1698f4c6d84af2e92de33fbcac4111913cd100a6ff"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:0446679737af14f45767963a1a9ef7620189912317d095f2d9ffa183a4d25d2b"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2010_i686.whl", hash = "sha256:f826e31d18b516f653fe296d967d700fddad5901ae07c622bb3705955e1faa94"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2010_x86_64.whl", hash = "sha256:fa130dd50c57d53368c9d59395cb5526eda596d3ffe36666cd81a44d56e48872"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:905fec760bd2fa1388bb5b489ee8ee5f7291d692638ea5f67982d968366bef9f"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bf5d821ffabf0ef3533c39c518f3357b171a1651c1ff6827325e4489b0e46c3c"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:0d4b31cc67ab36e3392bbf3862cfbadac3db12bdd8b02a2731f509ed5b829724"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:baa1a4e8f868845af802979fcdbf0bb11f94f1cb7ced4c4b8a351bb60d108145"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:deb993cacb280823246a026e3b2d81c493c53de6acfd5e6bfe31ab3402bb37dd"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:63f3268ba69ace99cab4e3e3b5840b03340efed0948ab8f78d2fd87ee5442a4f"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:8d206346619592c6200148b01a2142798c989edcb9c896f9ac9722a99d4e77e6"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-win32.whl", hash = "sha256:6c4ca60fa24e85fe25b912b01e62cb969d69a23a5d5867682dd3e80b5b02581d"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:b2f4bf27480f5e5e8ce285a8c8fd176c0b03e93dcc6646477d4630e83440c6a9"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:0717a7390a68be14b8c793ba258e075c6f4ca819f15edfc2a3a027c823718567"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:6557b31b5e2c9ddf0de32a691f2312a32f77cd7681d8af66c2692efdbef84c18"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:49e3ceeabbfb9d66c3aef5af3a60cc43b85c33df25ce03d0031a608b0a8b2e3f"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_i686.whl", hash = "sha256:d7f9850398e85aba693bb640262d3611788b1f29a79f0c93c565694658f4071f"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_x86_64.whl", hash = "sha256:6a7fae0dd14cf60ad5ff42baa2e95727c3d81ded453457771d02b7d2b3f9c0c2"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:b7f2d075102dc8c794cbde1947378051c4e5180d52d276987b8d28a3bd58c17d"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e9936f0b261d4df76ad22f8fee3ae83b60d7c3e871292cd42f40b81b70afae85"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:2a7d351cbd8cfeb19ca00de495e224dea7e7d919659c2841bbb7f420ad03e2d6"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:60bf42e36abfaf9aff1f50f52644b336d4f0a3fd6d8a60ca0d054ac9f713a864"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:d6c7ebd4e944c85e2c3421e612a7057a2f48d478d79e61800d81468a8d842207"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:f0567c4dc99f264f49fe27da5f735f414c4e7e7dd850cfd8e69f0862d7c74ea9"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:89c687013cb1cd489a0f0ac24febe8c7a666e6e221b783e53ac50ebf68e45d86"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-win32.whl", hash = "sha256:a30e67a65b53ea0a5e62fe23682cfe22712e01f453b95233b25502f7c61cb415"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:611d1ad9a4288cf3e3c16014564df047fe08410e628f89805e475368bd304914"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:5bb28c636d87e840583ee3adeb78172efc47c8b26127267f54a9c0ec251d41a9"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:be98f628055368795d818ebf93da628541e10b75b41c559fdf36d104c5787066"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux1_i686.whl", hash = "sha256:1d609f577dc6e1aa17d746f8bd3c31aa4d258f4070d61b2aa5c4166c1539de35"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:7d91275b0245b1da4d4cfa07e0faedd5b0812efc15b702576d103293e252af1b"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2010_i686.whl", hash = "sha256:01a9b8ea66f1658938f65b93a85ebe8bc016e6769611be228d797c9d998dd298"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2010_x86_64.whl", hash = "sha256:47ab1e7b91c098ab893b828deafa1203de86d0bc6ab587b160f78fe6c4011f75"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:97383d78eb34da7e1fa37dd273c20ad4320929af65d156e35a5e2d89566d9dfb"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6fcf051089389abe060c9cd7caa212c707e58153afa2c649f00346ce6d260f1b"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:5855f8438a7d1d458206a2466bf82b0f104a3724bf96a1c781ab731e4201731a"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:3dd007d54ee88b46be476e293f48c85048603f5f516008bee124ddd891398ed6"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:aca6377c0cb8a8253e493c6b451565ac77e98c2951c45f913e0b52facdcff83f"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:04635854b943835a6ea959e948d19dcd311762c5c0c6e1f0e16ee57022669194"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:6300b8454aa6930a24b9618fbb54b5a68135092bc666f7b06901f897fa5c2fee"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-win32.whl", hash = "sha256:023cb26ec21ece8dc3907c0e8320058b2e0cb3c55cf9564da612bc325bed5e64"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:984d76483eb32f1bcb536dc27e4ad56bba4baa70be32fa87152832cdd9db0833"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:2ef54abee730b502252bcdf31b10dacb0a416229b72c18b19e24a4509f273d26"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:3c112550557578c26af18a1ccc9e090bfe03832ae994343cfdacd287db6a6ae7"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux1_i686.whl", hash = "sha256:53edb4da6925ad13c07b6d26c2a852bd81e364f95301c66e930ab2aef5b5ddd8"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:f5653a225f31e113b152e56f154ccbe59eeb1c7487b39b9d9f9cdb58e6c79dc5"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2010_i686.whl", hash = "sha256:4efca8f86c54b22348a5467704e3fec767b2db12fc39c6d963168ab1d3fc9135"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2010_x86_64.whl", hash = "sha256:ab3ef638ace319fa26553db0624c4699e31a28bb2a835c5faca8f8acf6a5a902"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:f8ba0e8349a38d3001fae7eadded3f6606f0da5d748ee53cc1dab1d6527b9509"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c47adbc92fc1bb2b3274c4b3a43ae0e4573d9fbff4f54cd484555edbf030baf1"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:37205cac2a79194e3750b0af2a5720d95f786a55ce7df90c3af697bfa100eaac"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:1f2ade76b9903f39aa442b4aadd2177decb66525062db244b35d71d0ee8599b6"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:4296f2b1ce8c86a6aea78613c34bb1a672ea0e3de9c6ba08a960efe0b0a09047"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f02365d4e99430a12647f09b6cc8bab61a6564363f313126f775eb4f6ef798e"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5b6d930f030f8ed98e3e6c98ffa0652bdb82601e7a016ec2ab5d7ff23baa78d1"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-win32.whl", hash = "sha256:10f82115e21dc0dfec9ab5c0223652f7197feb168c940f3ef61563fc2d6beb74"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:693ce3f9e70a6cf7d2fb9e6c9d8b204b6b39897a2c4a1aa65728d5ac97dcc1d8"}, + {file = "MarkupSafe-2.0.1.tar.gz", hash = "sha256:594c67807fb16238b30c44bdf74f36c02cdf22d1c8cda91ef8a0ed8dabf5620a"}, +] +more-itertools = [ + {file = "more-itertools-8.12.0.tar.gz", hash = "sha256:7dc6ad46f05f545f900dd59e8dfb4e84a4827b97b3cfecb175ea0c7d247f6064"}, + {file = "more_itertools-8.12.0-py3-none-any.whl", hash = "sha256:43e6dd9942dffd72661a2c4ef383ad7da1e6a3e968a927ad7a6083ab410a688b"}, +] +packaging = [ + {file = "packaging-21.3-py3-none-any.whl", hash = "sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"}, + {file = "packaging-21.3.tar.gz", hash = "sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb"}, +] +pathtools = [ + {file = "pathtools-0.1.2.tar.gz", hash = "sha256:7c35c5421a39bb82e58018febd90e3b6e5db34c5443aaaf742b3f33d4655f1c0"}, +] +pluggy = [ + {file = "pluggy-0.13.1-py2.py3-none-any.whl", hash = "sha256:966c145cd83c96502c3c3868f50408687b38434af77734af1e9ca461a4081d2d"}, + {file = "pluggy-0.13.1.tar.gz", hash = "sha256:15b2acde666561e1298d71b523007ed7364de07029219b604cf808bfa1c765b0"}, +] +port-for = [ + {file = "port-for-0.3.1.tar.gz", hash = "sha256:b16a84bb29c2954db44c29be38b17c659c9c27e33918dec16b90d375cc596f1c"}, +] +py = [ + {file = "py-1.11.0-py2.py3-none-any.whl", hash = "sha256:607c53218732647dff4acdfcd50cb62615cedf612e72d1724fb1a0cc6405b378"}, + {file = "py-1.11.0.tar.gz", hash = "sha256:51c75c4126074b472f746a24399ad32f6053d1b34b68d2fa41e558e6f4a98719"}, +] +pygments = [ + {file = "Pygments-2.2.0-py2.py3-none-any.whl", hash = "sha256:78f3f434bcc5d6ee09020f92ba487f95ba50f1e3ef83ae96b9d5ffa1bab25c5d"}, + {file = "Pygments-2.2.0.tar.gz", hash = "sha256:dbae1046def0efb574852fab9e90209b23f556367b5a320c0bcb871c77c3e8cc"}, +] +pyparsing = [ + {file = "pyparsing-3.0.6-py3-none-any.whl", hash = "sha256:04ff808a5b90911829c55c4e26f75fa5ca8a2f5f36aa3a51f68e27033341d3e4"}, + {file = "pyparsing-3.0.6.tar.gz", hash = "sha256:d9bdec0013ef1eb5a84ab39a3b3868911598afa494f5faa038647101504e2b81"}, +] +pytest = [ + {file = "pytest-5.4.3-py3-none-any.whl", hash = "sha256:5c0db86b698e8f170ba4582a492248919255fcd4c79b1ee64ace34301fb589a1"}, + {file = "pytest-5.4.3.tar.gz", hash = "sha256:7979331bfcba207414f5e1263b5a0f8f521d0f457318836a7355531ed1a4c7d8"}, +] +pytz = [ + {file = "pytz-2021.3-py2.py3-none-any.whl", hash = "sha256:3672058bc3453457b622aab7a1c3bfd5ab0bdae451512f6cf25f64ed37f5b87c"}, + {file = "pytz-2021.3.tar.gz", hash = "sha256:acad2d8b20a1af07d4e4c9d2e9285c5ed9104354062f275f3fcd88dcef4f1326"}, +] +pyyaml = [ + {file = "PyYAML-5.4.1-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:3b2b1824fe7112845700f815ff6a489360226a5609b96ec2190a45e62a9fc922"}, + {file = "PyYAML-5.4.1-cp27-cp27m-win32.whl", hash = "sha256:129def1b7c1bf22faffd67b8f3724645203b79d8f4cc81f674654d9902cb4393"}, + {file = "PyYAML-5.4.1-cp27-cp27m-win_amd64.whl", hash = "sha256:4465124ef1b18d9ace298060f4eccc64b0850899ac4ac53294547536533800c8"}, + {file = "PyYAML-5.4.1-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:bb4191dfc9306777bc594117aee052446b3fa88737cd13b7188d0e7aa8162185"}, + {file = "PyYAML-5.4.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:6c78645d400265a062508ae399b60b8c167bf003db364ecb26dcab2bda048253"}, + {file = "PyYAML-5.4.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:4e0583d24c881e14342eaf4ec5fbc97f934b999a6828693a99157fde912540cc"}, + {file = "PyYAML-5.4.1-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:72a01f726a9c7851ca9bfad6fd09ca4e090a023c00945ea05ba1638c09dc3347"}, + {file = "PyYAML-5.4.1-cp36-cp36m-manylinux2014_s390x.whl", hash = "sha256:895f61ef02e8fed38159bb70f7e100e00f471eae2bc838cd0f4ebb21e28f8541"}, + {file = "PyYAML-5.4.1-cp36-cp36m-win32.whl", hash = "sha256:3bd0e463264cf257d1ffd2e40223b197271046d09dadf73a0fe82b9c1fc385a5"}, + {file = "PyYAML-5.4.1-cp36-cp36m-win_amd64.whl", hash = "sha256:e4fac90784481d221a8e4b1162afa7c47ed953be40d31ab4629ae917510051df"}, + {file = "PyYAML-5.4.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:5accb17103e43963b80e6f837831f38d314a0495500067cb25afab2e8d7a4018"}, + {file = "PyYAML-5.4.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:e1d4970ea66be07ae37a3c2e48b5ec63f7ba6804bdddfdbd3cfd954d25a82e63"}, + {file = "PyYAML-5.4.1-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:cb333c16912324fd5f769fff6bc5de372e9e7a202247b48870bc251ed40239aa"}, + {file = "PyYAML-5.4.1-cp37-cp37m-manylinux2014_s390x.whl", hash = "sha256:fe69978f3f768926cfa37b867e3843918e012cf83f680806599ddce33c2c68b0"}, + {file = "PyYAML-5.4.1-cp37-cp37m-win32.whl", hash = "sha256:dd5de0646207f053eb0d6c74ae45ba98c3395a571a2891858e87df7c9b9bd51b"}, + {file = "PyYAML-5.4.1-cp37-cp37m-win_amd64.whl", hash = "sha256:08682f6b72c722394747bddaf0aa62277e02557c0fd1c42cb853016a38f8dedf"}, + {file = "PyYAML-5.4.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:d2d9808ea7b4af864f35ea216be506ecec180628aced0704e34aca0b040ffe46"}, + {file = "PyYAML-5.4.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:8c1be557ee92a20f184922c7b6424e8ab6691788e6d86137c5d93c1a6ec1b8fb"}, + {file = "PyYAML-5.4.1-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:fd7f6999a8070df521b6384004ef42833b9bd62cfee11a09bda1079b4b704247"}, + {file = "PyYAML-5.4.1-cp38-cp38-manylinux2014_s390x.whl", hash = "sha256:bfb51918d4ff3d77c1c856a9699f8492c612cde32fd3bcd344af9be34999bfdc"}, + {file = "PyYAML-5.4.1-cp38-cp38-win32.whl", hash = "sha256:fa5ae20527d8e831e8230cbffd9f8fe952815b2b7dae6ffec25318803a7528fc"}, + {file = "PyYAML-5.4.1-cp38-cp38-win_amd64.whl", hash = "sha256:0f5f5786c0e09baddcd8b4b45f20a7b5d61a7e7e99846e3c799b05c7c53fa696"}, + {file = "PyYAML-5.4.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:294db365efa064d00b8d1ef65d8ea2c3426ac366c0c4368d930bf1c5fb497f77"}, + {file = "PyYAML-5.4.1-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:74c1485f7707cf707a7aef42ef6322b8f97921bd89be2ab6317fd782c2d53183"}, + {file = "PyYAML-5.4.1-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:d483ad4e639292c90170eb6f7783ad19490e7a8defb3e46f97dfe4bacae89122"}, + {file = "PyYAML-5.4.1-cp39-cp39-manylinux2014_s390x.whl", hash = "sha256:fdc842473cd33f45ff6bce46aea678a54e3d21f1b61a7750ce3c498eedfe25d6"}, + {file = "PyYAML-5.4.1-cp39-cp39-win32.whl", hash = "sha256:49d4cdd9065b9b6e206d0595fee27a96b5dd22618e7520c33204a4a3239d5b10"}, + {file = "PyYAML-5.4.1-cp39-cp39-win_amd64.whl", hash = "sha256:c20cfa2d49991c8b4147af39859b167664f2ad4561704ee74c1de03318e898db"}, + {file = "PyYAML-5.4.1.tar.gz", hash = "sha256:607774cbba28732bfa802b54baa7484215f530991055bb562efbed5b2f20a45e"}, +] +recommonmark = [ + {file = "recommonmark-0.5.0-py2.py3-none-any.whl", hash = "sha256:c85228b9b7aea7157662520e74b4e8791c5eacd375332ec68381b52bf10165be"}, + {file = "recommonmark-0.5.0.tar.gz", hash = "sha256:a520b8d25071a51ae23a27cf6252f2fe387f51bdc913390d83b2b50617f5bb48"}, +] +requests = [ + {file = "requests-2.26.0-py2.py3-none-any.whl", hash = "sha256:6c1246513ecd5ecd4528a0906f910e8f0f9c6b8ec72030dc9fd154dc1a6efd24"}, + {file = "requests-2.26.0.tar.gz", hash = "sha256:b8aa58f8cf793ffd8782d3d8cb19e66ef36f7aba4353eec859e74678b01b07a7"}, +] +six = [ + {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"}, + {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"}, +] +snowballstemmer = [ + {file = "snowballstemmer-2.2.0-py2.py3-none-any.whl", hash = "sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a"}, + {file = "snowballstemmer-2.2.0.tar.gz", hash = "sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1"}, +] +soupsieve = [ + {file = "soupsieve-2.3.1-py3-none-any.whl", hash = "sha256:1a3cca2617c6b38c0343ed661b1fa5de5637f257d4fe22bd9f1338010a1efefb"}, + {file = "soupsieve-2.3.1.tar.gz", hash = "sha256:b8d49b1cd4f037c7082a9683dfa1801aa2597fb11c3a1155b7a5b94829b4f1f9"}, +] +sphinx = [ + {file = "Sphinx-2.4.5-py3-none-any.whl", hash = "sha256:02d7e9dc5f30caa42a682b26de408b755a55c7b07f356a30a3b6300bf7d4740e"}, + {file = "Sphinx-2.4.5.tar.gz", hash = "sha256:b00394e90463e7482c4cf59e7db1c8604baeca1468abfc062904dedc1cea6fcc"}, +] +sphinx-autobuild = [ + {file = "sphinx-autobuild-0.7.1.tar.gz", hash = "sha256:66388f81884666e3821edbe05dd53a0cfb68093873d17320d0610de8db28c74e"}, + {file = "sphinx_autobuild-0.7.1-py2-none-any.whl", hash = "sha256:e60aea0789cab02fa32ee63c7acae5ef41c06f1434d9fd0a74250a61f5994692"}, +] +sphinx-copybutton = [ + {file = "sphinx-copybutton-0.2.12.tar.gz", hash = "sha256:9492883786984b6179c92c07ab0410237b26efa826adfa792acfd17b91a63e5c"}, + {file = "sphinx_copybutton-0.2.12-py3-none-any.whl", hash = "sha256:517870030a931f313695705edbe14a8c30660829716100d3d24b379cf9257060"}, +] +sphinx-multiversion-scylla = [ + {file = "sphinx-multiversion-scylla-0.2.10.tar.gz", hash = "sha256:b54d664ecedcf45b98d6be1e939eac596719daa514e4a35f58d8e6330fb05d22"}, +] +sphinx-notfound-page = [ + {file = "sphinx-notfound-page-0.6.tar.gz", hash = "sha256:5686892db509020d235069dd8a6c7e8bf6fcff43695046b945fe82925cb6c40c"}, + {file = "sphinx_notfound_page-0.6-py3-none-any.whl", hash = "sha256:3e8893d47638cc7ac06d4f6d10e97a18508658e36e530e7d24a429e6556c6894"}, +] +sphinx-scylladb-theme = [ + {file = "sphinx-scylladb-theme-1.0.6.tar.gz", hash = "sha256:58186e6ccde8fed1f743232fa8145443ece97d1aa06a988bbfbd3f976ffd3d9b"}, + {file = "sphinx_scylladb_theme-1.0.6-py3-none-any.whl", hash = "sha256:c81c2a2b50abb5d1a9bc46cb65304835f3d487d82957c1fc3c12a220e5b0f35b"}, +] +sphinx-sitemap = [ + {file = "sphinx-sitemap-2.1.0.tar.gz", hash = "sha256:ba3576f38e8d1cabde483dabed2cc2b958af85ff97f2a4442f990b02e967d6a5"}, +] +sphinx-tabs = [ + {file = "sphinx-tabs-3.2.0.tar.gz", hash = "sha256:33137914ed9b276e6a686d7a337310ee77b1dae316fdcbce60476913a152e0a4"}, + {file = "sphinx_tabs-3.2.0-py3-none-any.whl", hash = "sha256:1e1b1846c80137bd81a78e4a69b02664b98b1e1da361beb30600b939dfc75065"}, +] +sphinxcontrib-applehelp = [ + {file = "sphinxcontrib-applehelp-1.0.2.tar.gz", hash = "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58"}, + {file = "sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl", hash = "sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a"}, +] +sphinxcontrib-devhelp = [ + {file = "sphinxcontrib-devhelp-1.0.2.tar.gz", hash = "sha256:ff7f1afa7b9642e7060379360a67e9c41e8f3121f2ce9164266f61b9f4b338e4"}, + {file = "sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl", hash = "sha256:8165223f9a335cc1af7ffe1ed31d2871f325254c0423bc0c4c7cd1c1e4734a2e"}, +] +sphinxcontrib-htmlhelp = [ + {file = "sphinxcontrib-htmlhelp-2.0.0.tar.gz", hash = "sha256:f5f8bb2d0d629f398bf47d0d69c07bc13b65f75a81ad9e2f71a63d4b7a2f6db2"}, + {file = "sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl", hash = "sha256:d412243dfb797ae3ec2b59eca0e52dac12e75a241bf0e4eb861e450d06c6ed07"}, +] +sphinxcontrib-jsmath = [ + {file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"}, + {file = "sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178"}, +] +sphinxcontrib-qthelp = [ + {file = "sphinxcontrib-qthelp-1.0.3.tar.gz", hash = "sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72"}, + {file = "sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl", hash = "sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6"}, +] +sphinxcontrib-serializinghtml = [ + {file = "sphinxcontrib-serializinghtml-1.1.5.tar.gz", hash = "sha256:aa5f6de5dfdf809ef505c4895e51ef5c9eac17d0f287933eb49ec495280b6952"}, + {file = "sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl", hash = "sha256:352a9a00ae864471d3a7ead8d7d79f5fc0b57e8b3f95e9867eb9eb28999b92fd"}, +] +sphinxcontrib-youtube = [ + {file = "sphinxcontrib-youtube-1.0.1.tar.gz", hash = "sha256:ddf996279eb93cb1c3ab965812a109c30292915f8737afddb6be1ce6134dfcaf"}, + {file = "sphinxcontrib_youtube-1.0.1-py3-none-any.whl", hash = "sha256:8946236bcf0b4b786ea3e3002f499c5f1a3298ab368fc56109dceeb0531b3cef"}, +] +tornado = [ + {file = "tornado-6.1-cp35-cp35m-macosx_10_9_x86_64.whl", hash = "sha256:d371e811d6b156d82aa5f9a4e08b58debf97c302a35714f6f45e35139c332e32"}, + {file = "tornado-6.1-cp35-cp35m-manylinux1_i686.whl", hash = "sha256:0d321a39c36e5f2c4ff12b4ed58d41390460f798422c4504e09eb5678e09998c"}, + {file = "tornado-6.1-cp35-cp35m-manylinux1_x86_64.whl", hash = "sha256:9de9e5188a782be6b1ce866e8a51bc76a0fbaa0e16613823fc38e4fc2556ad05"}, + {file = "tornado-6.1-cp35-cp35m-manylinux2010_i686.whl", hash = "sha256:61b32d06ae8a036a6607805e6720ef00a3c98207038444ba7fd3d169cd998910"}, + {file = "tornado-6.1-cp35-cp35m-manylinux2010_x86_64.whl", hash = "sha256:3e63498f680547ed24d2c71e6497f24bca791aca2fe116dbc2bd0ac7f191691b"}, + {file = "tornado-6.1-cp35-cp35m-manylinux2014_aarch64.whl", hash = "sha256:6c77c9937962577a6a76917845d06af6ab9197702a42e1346d8ae2e76b5e3675"}, + {file = "tornado-6.1-cp35-cp35m-win32.whl", hash = "sha256:6286efab1ed6e74b7028327365cf7346b1d777d63ab30e21a0f4d5b275fc17d5"}, + {file = "tornado-6.1-cp35-cp35m-win_amd64.whl", hash = "sha256:fa2ba70284fa42c2a5ecb35e322e68823288a4251f9ba9cc77be04ae15eada68"}, + {file = "tornado-6.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:0a00ff4561e2929a2c37ce706cb8233b7907e0cdc22eab98888aca5dd3775feb"}, + {file = "tornado-6.1-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:748290bf9112b581c525e6e6d3820621ff020ed95af6f17fedef416b27ed564c"}, + {file = "tornado-6.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:e385b637ac3acaae8022e7e47dfa7b83d3620e432e3ecb9a3f7f58f150e50921"}, + {file = "tornado-6.1-cp36-cp36m-manylinux2010_i686.whl", hash = "sha256:25ad220258349a12ae87ede08a7b04aca51237721f63b1808d39bdb4b2164558"}, + {file = "tornado-6.1-cp36-cp36m-manylinux2010_x86_64.whl", hash = "sha256:65d98939f1a2e74b58839f8c4dab3b6b3c1ce84972ae712be02845e65391ac7c"}, + {file = "tornado-6.1-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:e519d64089b0876c7b467274468709dadf11e41d65f63bba207e04217f47c085"}, + {file = "tornado-6.1-cp36-cp36m-win32.whl", hash = "sha256:b87936fd2c317b6ee08a5741ea06b9d11a6074ef4cc42e031bc6403f82a32575"}, + {file = "tornado-6.1-cp36-cp36m-win_amd64.whl", hash = "sha256:cc0ee35043162abbf717b7df924597ade8e5395e7b66d18270116f8745ceb795"}, + {file = "tornado-6.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:7250a3fa399f08ec9cb3f7b1b987955d17e044f1ade821b32e5f435130250d7f"}, + {file = "tornado-6.1-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:ed3ad863b1b40cd1d4bd21e7498329ccaece75db5a5bf58cd3c9f130843e7102"}, + {file = "tornado-6.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:dcef026f608f678c118779cd6591c8af6e9b4155c44e0d1bc0c87c036fb8c8c4"}, + {file = "tornado-6.1-cp37-cp37m-manylinux2010_i686.whl", hash = "sha256:70dec29e8ac485dbf57481baee40781c63e381bebea080991893cd297742b8fd"}, + {file = "tornado-6.1-cp37-cp37m-manylinux2010_x86_64.whl", hash = "sha256:d3f7594930c423fd9f5d1a76bee85a2c36fd8b4b16921cae7e965f22575e9c01"}, + {file = "tornado-6.1-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:3447475585bae2e77ecb832fc0300c3695516a47d46cefa0528181a34c5b9d3d"}, + {file = "tornado-6.1-cp37-cp37m-win32.whl", hash = "sha256:e7229e60ac41a1202444497ddde70a48d33909e484f96eb0da9baf8dc68541df"}, + {file = "tornado-6.1-cp37-cp37m-win_amd64.whl", hash = "sha256:cb5ec8eead331e3bb4ce8066cf06d2dfef1bfb1b2a73082dfe8a161301b76e37"}, + {file = "tornado-6.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:20241b3cb4f425e971cb0a8e4ffc9b0a861530ae3c52f2b0434e6c1b57e9fd95"}, + {file = "tornado-6.1-cp38-cp38-manylinux1_i686.whl", hash = "sha256:c77da1263aa361938476f04c4b6c8916001b90b2c2fdd92d8d535e1af48fba5a"}, + {file = "tornado-6.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:fba85b6cd9c39be262fcd23865652920832b61583de2a2ca907dbd8e8a8c81e5"}, + {file = "tornado-6.1-cp38-cp38-manylinux2010_i686.whl", hash = "sha256:1e8225a1070cd8eec59a996c43229fe8f95689cb16e552d130b9793cb570a288"}, + {file = "tornado-6.1-cp38-cp38-manylinux2010_x86_64.whl", hash = "sha256:d14d30e7f46a0476efb0deb5b61343b1526f73ebb5ed84f23dc794bdb88f9d9f"}, + {file = "tornado-6.1-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:8f959b26f2634a091bb42241c3ed8d3cedb506e7c27b8dd5c7b9f745318ddbb6"}, + {file = "tornado-6.1-cp38-cp38-win32.whl", hash = "sha256:34ca2dac9e4d7afb0bed4677512e36a52f09caa6fded70b4e3e1c89dbd92c326"}, + {file = "tornado-6.1-cp38-cp38-win_amd64.whl", hash = "sha256:6196a5c39286cc37c024cd78834fb9345e464525d8991c21e908cc046d1cc02c"}, + {file = "tornado-6.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:f0ba29bafd8e7e22920567ce0d232c26d4d47c8b5cf4ed7b562b5db39fa199c5"}, + {file = "tornado-6.1-cp39-cp39-manylinux1_i686.whl", hash = "sha256:33892118b165401f291070100d6d09359ca74addda679b60390b09f8ef325ffe"}, + {file = "tornado-6.1-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:7da13da6f985aab7f6f28debab00c67ff9cbacd588e8477034c0652ac141feea"}, + {file = "tornado-6.1-cp39-cp39-manylinux2010_i686.whl", hash = "sha256:e0791ac58d91ac58f694d8d2957884df8e4e2f6687cdf367ef7eb7497f79eaa2"}, + {file = "tornado-6.1-cp39-cp39-manylinux2010_x86_64.whl", hash = "sha256:66324e4e1beede9ac79e60f88de548da58b1f8ab4b2f1354d8375774f997e6c0"}, + {file = "tornado-6.1-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:a48900ecea1cbb71b8c71c620dee15b62f85f7c14189bdeee54966fbd9a0c5bd"}, + {file = "tornado-6.1-cp39-cp39-win32.whl", hash = "sha256:d3d20ea5782ba63ed13bc2b8c291a053c8d807a8fa927d941bd718468f7b950c"}, + {file = "tornado-6.1-cp39-cp39-win_amd64.whl", hash = "sha256:548430be2740e327b3fe0201abe471f314741efcb0067ec4f2d7dcfb4825f3e4"}, + {file = "tornado-6.1.tar.gz", hash = "sha256:33c6e81d7bd55b468d2e793517c909b139960b6c790a60b7991b9b6b76fb9791"}, +] +typing-extensions = [ + {file = "typing_extensions-4.0.1-py3-none-any.whl", hash = "sha256:7f001e5ac290a0c0401508864c7ec868be4e701886d5b573a9528ed3973d9d3b"}, + {file = "typing_extensions-4.0.1.tar.gz", hash = "sha256:4ca091dea149f945ec56afb48dae714f21e8692ef22a395223bcd328961b6a0e"}, +] +urllib3 = [ + {file = "urllib3-1.26.7-py2.py3-none-any.whl", hash = "sha256:c4fdf4019605b6e5423637e01bc9fe4daef873709a7973e195ceba0a62bbc844"}, + {file = "urllib3-1.26.7.tar.gz", hash = "sha256:4987c65554f7a2dbf30c18fd48778ef124af6fab771a377103da0585e2336ece"}, +] +watchdog = [ + {file = "watchdog-2.1.6-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:9693f35162dc6208d10b10ddf0458cc09ad70c30ba689d9206e02cd836ce28a3"}, + {file = "watchdog-2.1.6-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:aba5c812f8ee8a3ff3be51887ca2d55fb8e268439ed44110d3846e4229eb0e8b"}, + {file = "watchdog-2.1.6-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:4ae38bf8ba6f39d5b83f78661273216e7db5b00f08be7592062cb1fc8b8ba542"}, + {file = "watchdog-2.1.6-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:ad6f1796e37db2223d2a3f302f586f74c72c630b48a9872c1e7ae8e92e0ab669"}, + {file = "watchdog-2.1.6-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:922a69fa533cb0c793b483becaaa0845f655151e7256ec73630a1b2e9ebcb660"}, + {file = "watchdog-2.1.6-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:b2fcf9402fde2672545b139694284dc3b665fd1be660d73eca6805197ef776a3"}, + {file = "watchdog-2.1.6-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:3386b367e950a11b0568062b70cc026c6f645428a698d33d39e013aaeda4cc04"}, + {file = "watchdog-2.1.6-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:8f1c00aa35f504197561060ca4c21d3cc079ba29cf6dd2fe61024c70160c990b"}, + {file = "watchdog-2.1.6-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:b52b88021b9541a60531142b0a451baca08d28b74a723d0c99b13c8c8d48d604"}, + {file = "watchdog-2.1.6-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:8047da932432aa32c515ec1447ea79ce578d0559362ca3605f8e9568f844e3c6"}, + {file = "watchdog-2.1.6-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:e92c2d33858c8f560671b448205a268096e17870dcf60a9bb3ac7bfbafb7f5f9"}, + {file = "watchdog-2.1.6-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:b7d336912853d7b77f9b2c24eeed6a5065d0a0cc0d3b6a5a45ad6d1d05fb8cd8"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_aarch64.whl", hash = "sha256:cca7741c0fcc765568350cb139e92b7f9f3c9a08c4f32591d18ab0a6ac9e71b6"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_armv7l.whl", hash = "sha256:25fb5240b195d17de949588628fdf93032ebf163524ef08933db0ea1f99bd685"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_i686.whl", hash = "sha256:be9be735f827820a06340dff2ddea1fb7234561fa5e6300a62fe7f54d40546a0"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_ppc64.whl", hash = "sha256:d0d19fb2441947b58fbf91336638c2b9f4cc98e05e1045404d7a4cb7cddc7a65"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:3becdb380d8916c873ad512f1701f8a92ce79ec6978ffde92919fd18d41da7fb"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_s390x.whl", hash = "sha256:ae67501c95606072aafa865b6ed47343ac6484472a2f95490ba151f6347acfc2"}, + {file = "watchdog-2.1.6-py3-none-manylinux2014_x86_64.whl", hash = "sha256:e0f30db709c939cabf64a6dc5babb276e6d823fd84464ab916f9b9ba5623ca15"}, + {file = "watchdog-2.1.6-py3-none-win32.whl", hash = "sha256:e02794ac791662a5eafc6ffeaf9bcc149035a0e48eb0a9d40a8feb4622605a3d"}, + {file = "watchdog-2.1.6-py3-none-win_amd64.whl", hash = "sha256:bd9ba4f332cf57b2c1f698be0728c020399ef3040577cde2939f2e045b39c1e5"}, + {file = "watchdog-2.1.6-py3-none-win_ia64.whl", hash = "sha256:a0f1c7edf116a12f7245be06120b1852275f9506a7d90227648b250755a03923"}, + {file = "watchdog-2.1.6.tar.gz", hash = "sha256:a36e75df6c767cbf46f61a91c70b3ba71811dfa0aca4a324d9407a06a8b7a2e7"}, +] +wcwidth = [ + {file = "wcwidth-0.2.5-py2.py3-none-any.whl", hash = "sha256:beb4802a9cebb9144e99086eff703a642a13d6a0052920003a230f3294bbe784"}, + {file = "wcwidth-0.2.5.tar.gz", hash = "sha256:c4d647b99872929fdb7bdcaa4fbe7f01413ed3d98077df798530e5b04f116c83"}, +] +zipp = [ + {file = "zipp-3.7.0-py3-none-any.whl", hash = "sha256:b47250dd24f92b7dd6a0a8fc5244da14608f3ca90a5efcd37a3b1642fac9a375"}, + {file = "zipp-3.7.0.tar.gz", hash = "sha256:9f50f446828eb9d45b267433fd3e9da8d801f614129124863f9c51ebceafb87d"}, +] diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..296dff7 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,27 @@ +[tool.poetry] +name = "start9-docs" +description = "Start9 Documentation" +version = "0.1.0" +authors = ["elvece , kn0wmad "] + +[tool.poetry.dependencies] +python = "^3.7" +pyyaml = "^5.3" +pygments = "2.2.0" +recommonmark = "0.5.0" +sphinx-scylladb-theme = "1.0.6" +sphinx-sitemap = "2.1.0" +Sphinx = "^2.4.4" +sphinx-multiversion-scylla = "^0.2.6" +beautifulsoup4 = "^4.9.3" +sphinx-tabs = "^3.1.0" +sphinxcontrib-youtube = "^1.0.1" + + +[tool.poetry.dev-dependencies] +pytest = "^5.2" +sphinx-autobuild = "^0.7.1" + +[build-system] +requires = ["poetry>=0.12"] +build-backend = "poetry.masonry.api" diff --git a/site/Makefile b/site/Makefile new file mode 100644 index 0000000..deb4049 --- /dev/null +++ b/site/Makefile @@ -0,0 +1,64 @@ +# 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: 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: 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/site/_utils/deploy_staging.sh b/site/_utils/deploy_staging.sh new file mode 100755 index 0000000..ecc0bb1 --- /dev/null +++ b/site/_utils/deploy_staging.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +# Copy contents +mkdir gh-pages +cp -r ./docs/_build/dirhtml/. gh-pages + +# Create gh-pages branch +cd gh-pages +git init +git config --local user.email "dev@start9labs.com" +git config --local user.name "Start9 Dev" +git remote add origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" +git checkout -b gh-pages + +# Deploy +git add . +git commit -m "Publish docs" || true +git push origin gh-pages --force diff --git a/site/_utils/setup.sh b/site/_utils/setup.sh new file mode 100755 index 0000000..b8f5024 --- /dev/null +++ b/site/_utils/setup.sh @@ -0,0 +1,11 @@ +#! /bin/bash + +if pwd | egrep -q '\s'; then + echo "Working directory name contains one or more spaces." + exit 1 +fi + +which python3 || { echo "Failed to find python3. Try installing Python for your operative system: https://www.python.org/downloads/" && exit 1; } +which poetry || curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/1.1.3/get-poetry.py | python3 - && source ${HOME}/.poetry/env +poetry install +poetry update diff --git a/site/source/_static/favicon.ico b/site/source/_static/favicon.ico new file mode 100644 index 0000000..b84fec3 Binary files /dev/null and b/site/source/_static/favicon.ico differ diff --git a/source/_static/images/about_screen.png b/site/source/_static/images/about_screen.png similarity index 100% rename from source/_static/images/about_screen.png rename to site/source/_static/images/about_screen.png diff --git a/source/_static/images/backup_warning.png b/site/source/_static/images/backup_warning.png similarity index 100% rename from source/_static/images/backup_warning.png rename to site/source/_static/images/backup_warning.png diff --git a/source/_static/images/bitcoin_backup_view_no_storage.png b/site/source/_static/images/bitcoin_backup_view_no_storage.png similarity index 100% rename from source/_static/images/bitcoin_backup_view_no_storage.png rename to site/source/_static/images/bitcoin_backup_view_no_storage.png diff --git a/source/_static/images/bitcoin_backup_view_storage.png b/site/source/_static/images/bitcoin_backup_view_storage.png similarity index 100% rename from source/_static/images/bitcoin_backup_view_storage.png rename to site/source/_static/images/bitcoin_backup_view_storage.png diff --git a/source/_static/images/bitcoin_creating_backup.png b/site/source/_static/images/bitcoin_creating_backup.png similarity index 100% rename from source/_static/images/bitcoin_creating_backup.png rename to site/source/_static/images/bitcoin_creating_backup.png diff --git a/source/_static/images/bitcoin_instructions.png b/site/source/_static/images/bitcoin_instructions.png similarity index 100% rename from source/_static/images/bitcoin_instructions.png rename to site/source/_static/images/bitcoin_instructions.png diff --git a/source/_static/images/bitcoin_instructions_view.png b/site/source/_static/images/bitcoin_instructions_view.png similarity index 100% rename from source/_static/images/bitcoin_instructions_view.png rename to site/source/_static/images/bitcoin_instructions_view.png diff --git a/source/_static/images/bitcoin_view.png b/site/source/_static/images/bitcoin_view.png similarity index 100% rename from source/_static/images/bitcoin_view.png rename to site/source/_static/images/bitcoin_view.png diff --git a/source/_static/images/decrypt_backup.png b/site/source/_static/images/decrypt_backup.png similarity index 100% rename from source/_static/images/decrypt_backup.png rename to site/source/_static/images/decrypt_backup.png diff --git a/source/_static/images/diy/balena.png b/site/source/_static/images/diy/balena.png similarity index 100% rename from source/_static/images/diy/balena.png rename to site/source/_static/images/diy/balena.png diff --git a/source/_static/images/diy/pi.png b/site/source/_static/images/diy/pi.png similarity index 100% rename from source/_static/images/diy/pi.png rename to site/source/_static/images/diy/pi.png diff --git a/source/_static/images/diy/pins.png b/site/source/_static/images/diy/pins.png similarity index 100% rename from source/_static/images/diy/pins.png rename to site/source/_static/images/diy/pins.png diff --git a/source/_static/images/embassy_auto_check_updates.png b/site/source/_static/images/embassy_auto_check_updates.png similarity index 100% rename from source/_static/images/embassy_auto_check_updates.png rename to site/source/_static/images/embassy_auto_check_updates.png diff --git a/source/_static/images/embassy_config.png b/site/source/_static/images/embassy_config.png similarity index 100% rename from source/_static/images/embassy_config.png rename to site/source/_static/images/embassy_config.png diff --git a/source/_static/images/embassy_lan_setup.png b/site/source/_static/images/embassy_lan_setup.png similarity index 100% rename from source/_static/images/embassy_lan_setup.png rename to site/source/_static/images/embassy_lan_setup.png diff --git a/source/_static/images/embassy_metrics.png b/site/source/_static/images/embassy_metrics.png similarity index 100% rename from source/_static/images/embassy_metrics.png rename to site/source/_static/images/embassy_metrics.png diff --git a/source/_static/images/embassy_notification.png b/site/source/_static/images/embassy_notification.png similarity index 100% rename from source/_static/images/embassy_notification.png rename to site/source/_static/images/embassy_notification.png diff --git a/source/_static/images/embassy_notifications.png b/site/source/_static/images/embassy_notifications.png similarity index 100% rename from source/_static/images/embassy_notifications.png rename to site/source/_static/images/embassy_notifications.png diff --git a/source/_static/images/embassy_tab.png b/site/source/_static/images/embassy_tab.png similarity index 100% rename from source/_static/images/embassy_tab.png rename to site/source/_static/images/embassy_tab.png diff --git a/source/_static/images/embassy_wifi.png b/site/source/_static/images/embassy_wifi.png similarity index 100% rename from source/_static/images/embassy_wifi.png rename to site/source/_static/images/embassy_wifi.png diff --git a/source/_static/images/private_dns.png b/site/source/_static/images/private_dns.png similarity index 100% rename from source/_static/images/private_dns.png rename to site/source/_static/images/private_dns.png diff --git a/source/_static/images/restore_backup_menu.png b/site/source/_static/images/restore_backup_menu.png similarity index 100% rename from source/_static/images/restore_backup_menu.png rename to site/source/_static/images/restore_backup_menu.png diff --git a/source/_static/images/restore_backup_submenu.png b/site/source/_static/images/restore_backup_submenu.png similarity index 100% rename from source/_static/images/restore_backup_submenu.png rename to site/source/_static/images/restore_backup_submenu.png diff --git a/source/_static/images/restoring_backup.png b/site/source/_static/images/restoring_backup.png similarity index 100% rename from source/_static/images/restoring_backup.png rename to site/source/_static/images/restoring_backup.png diff --git a/source/_static/images/secure_lan_setup_page.png b/site/source/_static/images/secure_lan_setup_page.png similarity index 100% rename from source/_static/images/secure_lan_setup_page.png rename to site/source/_static/images/secure_lan_setup_page.png diff --git a/source/_static/images/secure_lan_setup_prompt.png b/site/source/_static/images/secure_lan_setup_prompt.png similarity index 100% rename from source/_static/images/secure_lan_setup_prompt.png rename to site/source/_static/images/secure_lan_setup_prompt.png diff --git a/source/_static/images/service/bitcoin_config.png b/site/source/_static/images/service/bitcoin_config.png similarity index 100% rename from source/_static/images/service/bitcoin_config.png rename to site/source/_static/images/service/bitcoin_config.png diff --git a/source/_static/images/service/bitcoin_instructions.png b/site/source/_static/images/service/bitcoin_instructions.png similarity index 100% rename from source/_static/images/service/bitcoin_instructions.png rename to site/source/_static/images/service/bitcoin_instructions.png diff --git a/source/_static/images/service/bitcoin_rpc.png b/site/source/_static/images/service/bitcoin_rpc.png similarity index 100% rename from source/_static/images/service/bitcoin_rpc.png rename to site/source/_static/images/service/bitcoin_rpc.png diff --git a/source/_static/images/service/boolean_toggle.png b/site/source/_static/images/service/boolean_toggle.png similarity index 100% rename from source/_static/images/service/boolean_toggle.png rename to site/source/_static/images/service/boolean_toggle.png diff --git a/source/_static/images/service/btcproxy_config.png b/site/source/_static/images/service/btcproxy_config.png similarity index 100% rename from source/_static/images/service/btcproxy_config.png rename to site/source/_static/images/service/btcproxy_config.png diff --git a/source/_static/images/service/btcproxy_rpc.png b/site/source/_static/images/service/btcproxy_rpc.png similarity index 100% rename from source/_static/images/service/btcproxy_rpc.png rename to site/source/_static/images/service/btcproxy_rpc.png diff --git a/source/_static/images/service/service_properties.png b/site/source/_static/images/service/service_properties.png similarity index 100% rename from source/_static/images/service/service_properties.png rename to site/source/_static/images/service/service_properties.png diff --git a/source/_static/images/ssl/browser/brave_security_settings.png b/site/source/_static/images/ssl/browser/brave_security_settings.png similarity index 100% rename from source/_static/images/ssl/browser/brave_security_settings.png rename to site/source/_static/images/ssl/browser/brave_security_settings.png diff --git a/source/_static/images/ssl/browser/brave_view_certs.png b/site/source/_static/images/ssl/browser/brave_view_certs.png similarity index 100% rename from source/_static/images/ssl/browser/brave_view_certs.png rename to site/source/_static/images/ssl/browser/brave_view_certs.png diff --git a/source/_static/images/ssl/browser/firefox_security_settings.png b/site/source/_static/images/ssl/browser/firefox_security_settings.png similarity index 100% rename from source/_static/images/ssl/browser/firefox_security_settings.png rename to site/source/_static/images/ssl/browser/firefox_security_settings.png diff --git a/source/_static/images/ssl/browser/firefox_view_certs.png b/site/source/_static/images/ssl/browser/firefox_view_certs.png similarity index 100% rename from source/_static/images/ssl/browser/firefox_view_certs.png rename to site/source/_static/images/ssl/browser/firefox_view_certs.png diff --git a/source/_static/images/ssl/macos/always_trust.png b/site/source/_static/images/ssl/macos/always_trust.png similarity index 100% rename from source/_static/images/ssl/macos/always_trust.png rename to site/source/_static/images/ssl/macos/always_trust.png diff --git a/source/_static/images/ssl/macos/certificate_trusted.png b/site/source/_static/images/ssl/macos/certificate_trusted.png similarity index 100% rename from source/_static/images/ssl/macos/certificate_trusted.png rename to site/source/_static/images/ssl/macos/certificate_trusted.png diff --git a/source/_static/images/ssl/macos/certificate_untrusted.png b/site/source/_static/images/ssl/macos/certificate_untrusted.png similarity index 100% rename from source/_static/images/ssl/macos/certificate_untrusted.png rename to site/source/_static/images/ssl/macos/certificate_untrusted.png diff --git a/source/_static/images/ssl/mobile/ssl_certificate_install_page.PNG b/site/source/_static/images/ssl/mobile/ssl_certificate_install_page.PNG similarity index 100% rename from source/_static/images/ssl/mobile/ssl_certificate_install_page.PNG rename to site/source/_static/images/ssl/mobile/ssl_certificate_install_page.PNG diff --git a/source/_static/images/ssl/mobile/ssl_ipad_cert_trust.PNG b/site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust.PNG similarity index 100% rename from source/_static/images/ssl/mobile/ssl_ipad_cert_trust.PNG rename to site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust.PNG diff --git a/source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.PNG b/site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.PNG similarity index 100% rename from source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.PNG rename to site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.PNG diff --git a/source/_static/images/ssl/mobile/ssl_ipad_general_settings.PNG b/site/source/_static/images/ssl/mobile/ssl_ipad_general_settings.PNG similarity index 100% rename from source/_static/images/ssl/mobile/ssl_ipad_general_settings.PNG rename to site/source/_static/images/ssl/mobile/ssl_ipad_general_settings.PNG diff --git a/source/_static/images/ssl/mobile/ssl_ipad_install_profile.PNG b/site/source/_static/images/ssl/mobile/ssl_ipad_install_profile.PNG similarity index 100% rename from source/_static/images/ssl/mobile/ssl_ipad_install_profile.PNG rename to site/source/_static/images/ssl/mobile/ssl_ipad_install_profile.PNG diff --git a/source/_static/images/ssl/mobile/ssl_ipad_profiles.PNG b/site/source/_static/images/ssl/mobile/ssl_ipad_profiles.PNG similarity index 100% rename from source/_static/images/ssl/mobile/ssl_ipad_profiles.PNG rename to site/source/_static/images/ssl/mobile/ssl_ipad_profiles.PNG diff --git a/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG b/site/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG similarity index 100% rename from source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG rename to site/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG diff --git a/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG b/site/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG similarity index 100% rename from source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG rename to site/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG diff --git a/source/_static/images/ssl/windows/1_windows_mmc.png b/site/source/_static/images/ssl/windows/1_windows_mmc.png similarity index 100% rename from source/_static/images/ssl/windows/1_windows_mmc.png rename to site/source/_static/images/ssl/windows/1_windows_mmc.png diff --git a/source/_static/images/ssl/windows/2_windows_console_root.png b/site/source/_static/images/ssl/windows/2_windows_console_root.png similarity index 100% rename from source/_static/images/ssl/windows/2_windows_console_root.png rename to site/source/_static/images/ssl/windows/2_windows_console_root.png diff --git a/source/_static/images/ssl/windows/3_windows_add_certificates.png b/site/source/_static/images/ssl/windows/3_windows_add_certificates.png similarity index 100% rename from source/_static/images/ssl/windows/3_windows_add_certificates.png rename to site/source/_static/images/ssl/windows/3_windows_add_certificates.png diff --git a/source/_static/images/ssl/windows/4_windows_selected_snapin.png b/site/source/_static/images/ssl/windows/4_windows_selected_snapin.png similarity index 100% rename from source/_static/images/ssl/windows/4_windows_selected_snapin.png rename to site/source/_static/images/ssl/windows/4_windows_selected_snapin.png diff --git a/source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.png b/site/source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.png similarity index 100% rename from source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.png rename to site/source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.png diff --git a/source/_static/images/ssl/windows/6_windows_import_cert.png b/site/source/_static/images/ssl/windows/6_windows_import_cert.png similarity index 100% rename from source/_static/images/ssl/windows/6_windows_import_cert.png rename to site/source/_static/images/ssl/windows/6_windows_import_cert.png diff --git a/source/_static/images/ssl/windows/7_windows_import_cert_wizard.png b/site/source/_static/images/ssl/windows/7_windows_import_cert_wizard.png similarity index 100% rename from source/_static/images/ssl/windows/7_windows_import_cert_wizard.png rename to site/source/_static/images/ssl/windows/7_windows_import_cert_wizard.png diff --git a/source/_static/images/ssl/windows/8_windows_successful_cert_install.png b/site/source/_static/images/ssl/windows/8_windows_successful_cert_install.png similarity index 100% rename from source/_static/images/ssl/windows/8_windows_successful_cert_install.png rename to site/source/_static/images/ssl/windows/8_windows_successful_cert_install.png diff --git a/source/_static/images/ssl/windows/windows_download_cert.png b/site/source/_static/images/ssl/windows/windows_download_cert.png similarity index 100% rename from source/_static/images/ssl/windows/windows_download_cert.png rename to site/source/_static/images/ssl/windows/windows_download_cert.png diff --git a/source/_static/images/tor/about_config.png b/site/source/_static/images/tor/about_config.png similarity index 100% rename from source/_static/images/tor/about_config.png rename to site/source/_static/images/tor/about_config.png diff --git a/source/_static/images/tor/autoconfig_url.png b/site/source/_static/images/tor/autoconfig_url.png similarity index 100% rename from source/_static/images/tor/autoconfig_url.png rename to site/source/_static/images/tor/autoconfig_url.png diff --git a/source/_static/images/tor/firefox_options_windows.png b/site/source/_static/images/tor/firefox_options_windows.png similarity index 100% rename from source/_static/images/tor/firefox_options_windows.png rename to site/source/_static/images/tor/firefox_options_windows.png diff --git a/source/_static/images/tor/firefox_preferences.png b/site/source/_static/images/tor/firefox_preferences.png similarity index 100% rename from source/_static/images/tor/firefox_preferences.png rename to site/source/_static/images/tor/firefox_preferences.png diff --git a/source/_static/images/tor/firefox_proxy.png b/site/source/_static/images/tor/firefox_proxy.png similarity index 100% rename from source/_static/images/tor/firefox_proxy.png rename to site/source/_static/images/tor/firefox_proxy.png diff --git a/source/_static/images/tor/firefox_search.png b/site/source/_static/images/tor/firefox_search.png similarity index 100% rename from source/_static/images/tor/firefox_search.png rename to site/source/_static/images/tor/firefox_search.png diff --git a/source/_static/images/tor/firefox_whitelist.png b/site/source/_static/images/tor/firefox_whitelist.png similarity index 100% rename from source/_static/images/tor/firefox_whitelist.png rename to site/source/_static/images/tor/firefox_whitelist.png diff --git a/source/_static/images/tor/firefox_whitelist_mobile.png b/site/source/_static/images/tor/firefox_whitelist_mobile.png similarity index 100% rename from source/_static/images/tor/firefox_whitelist_mobile.png rename to site/source/_static/images/tor/firefox_whitelist_mobile.png diff --git a/source/_static/images/tor/install_homebrew.png b/site/source/_static/images/tor/install_homebrew.png similarity index 100% rename from source/_static/images/tor/install_homebrew.png rename to site/source/_static/images/tor/install_homebrew.png diff --git a/source/_static/images/tor/install_homebrew1.png b/site/source/_static/images/tor/install_homebrew1.png similarity index 100% rename from source/_static/images/tor/install_homebrew1.png rename to site/source/_static/images/tor/install_homebrew1.png diff --git a/source/_static/images/tor/install_tor.png b/site/source/_static/images/tor/install_tor.png similarity index 100% rename from source/_static/images/tor/install_tor.png rename to site/source/_static/images/tor/install_tor.png diff --git a/source/_static/images/tor/network_proxy_type.png b/site/source/_static/images/tor/network_proxy_type.png similarity index 100% rename from source/_static/images/tor/network_proxy_type.png rename to site/source/_static/images/tor/network_proxy_type.png diff --git a/source/_static/images/tor/orbot_apps.png b/site/source/_static/images/tor/orbot_apps.png similarity index 100% rename from source/_static/images/tor/orbot_apps.png rename to site/source/_static/images/tor/orbot_apps.png diff --git a/source/_static/images/tor/orbot_menu.png b/site/source/_static/images/tor/orbot_menu.png similarity index 100% rename from source/_static/images/tor/orbot_menu.png rename to site/source/_static/images/tor/orbot_menu.png diff --git a/source/_static/images/tor/orbot_settings.png b/site/source/_static/images/tor/orbot_settings.png similarity index 100% rename from source/_static/images/tor/orbot_settings.png rename to site/source/_static/images/tor/orbot_settings.png diff --git a/source/_static/images/tor/orbot_start.png b/site/source/_static/images/tor/orbot_start.png similarity index 100% rename from source/_static/images/tor/orbot_start.png rename to site/source/_static/images/tor/orbot_start.png diff --git a/source/_static/images/tor/orbot_started.png b/site/source/_static/images/tor/orbot_started.png similarity index 100% rename from source/_static/images/tor/orbot_started.png rename to site/source/_static/images/tor/orbot_started.png diff --git a/source/_static/images/tor/orbot_vpn.png b/site/source/_static/images/tor/orbot_vpn.png similarity index 100% rename from source/_static/images/tor/orbot_vpn.png rename to site/source/_static/images/tor/orbot_vpn.png diff --git a/source/_static/images/tor/private_dns_off.png b/site/source/_static/images/tor/private_dns_off.png similarity index 100% rename from source/_static/images/tor/private_dns_off.png rename to site/source/_static/images/tor/private_dns_off.png diff --git a/source/_static/images/tor/socks_remote_dns.png b/site/source/_static/images/tor/socks_remote_dns.png similarity index 100% rename from source/_static/images/tor/socks_remote_dns.png rename to site/source/_static/images/tor/socks_remote_dns.png diff --git a/source/_static/images/tor/tor_download_windows.png b/site/source/_static/images/tor/tor_download_windows.png similarity index 100% rename from source/_static/images/tor/tor_download_windows.png rename to site/source/_static/images/tor/tor_download_windows.png diff --git a/source/_static/images/tor/tor_windows_install.png b/site/source/_static/images/tor/tor_windows_install.png similarity index 100% rename from source/_static/images/tor/tor_windows_install.png rename to site/source/_static/images/tor/tor_windows_install.png diff --git a/source/_static/images/tor/tor_windows_terminal.png b/site/source/_static/images/tor/tor_windows_terminal.png similarity index 100% rename from source/_static/images/tor/tor_windows_terminal.png rename to site/source/_static/images/tor/tor_windows_terminal.png diff --git a/source/_static/logo.png b/site/source/_static/logo.png similarity index 100% rename from source/_static/logo.png rename to site/source/_static/logo.png diff --git a/source/_templates/layout.html b/site/source/_templates/layout.html similarity index 90% rename from source/_templates/layout.html rename to site/source/_templates/layout.html index 3fbeb16..bb95615 100644 --- a/source/_templates/layout.html +++ b/site/source/_templates/layout.html @@ -2,8 +2,6 @@ {# Import the layout of the theme. #} {% extends "!layout.html" %} -{% set css_files = css_files + ['_static/default.css'] %} - {% block extrahead %} diff --git a/site/source/conf.py b/site/source/conf.py new file mode 100644 index 0000000..5407171 --- /dev/null +++ b/site/source/conf.py @@ -0,0 +1,137 @@ +# Configuration file for the Sphinx documentation builder. +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +from datetime import date + +from sphinx_scylladb_theme.utils import multiversion_regex_builder +sys.path.insert(0, os.path.abspath('..')) + +# -- Project information ----------------------------------------------------- + +project = 'Start9 Docs' +copyright = str(date.today().year) + ", Start9 Labs, Inc. All rights reserved." +author = u"Start9 Contributors" + + +# -- General configuration --------------------------------------------------- + +# Target Sphinx version +needs_sphinx = "1.8" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.todo", + "sphinx.ext.mathjax", + "sphinx.ext.extlinks", + "sphinx_scylladb_theme", + 'sphinxcontrib.youtube', + 'sphinx_multiversion', +] + +# The suffix(es) of source filenames. +source_suffix = [".rst", ".md"] +autosectionlabel_prefix_document = True + +# The master toctree document. +master_doc = "index" + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ["build", "Thumbs.db", ".DS_Store"] + +# The name of the Pygments (code syntax highlighting) style to use. +pygments_style = "sphinx" + +# List of substitutions +rst_prolog = """ +.. |rst| replace:: RestructuredText +""" + +# -- Options for not found extension ------------------------------------------- +# Template used to render the 404.html generated by this extension. +notfound_template = "404.html" + +# -- Options for multiversion extension ---------------------------------- + +# Whitelist pattern for tags (set to None to ignore all tags) +TAGS = [] +smv_tag_whitelist = multiversion_regex_builder(TAGS) +# Whitelist pattern for branches (set to None to ignore all branches) +BRANCHES = ["versioning", "master"] +smv_branch_whitelist = multiversion_regex_builder(BRANCHES) +# Defines which version is considered to be the latest stable version. +# Must be listed in smv_tag_whitelist or smv_branch_whitelist. +smv_latest_version = "master" +smv_rename_latest_version = "latest" +# Whitelist pattern for remotes (set to None to use local branches only) +smv_remote_whitelist = r"^origin$" +# Pattern for released versions +smv_released_pattern = r'^tags/.*$' +# Format for versioned output directories inside the build directory +smv_outputdir_format = '{ref.name}' +# Determines whether remote or local git branches/tags are preferred if their output dirs conflict +smv_prefer_remote_refs = False + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML pages. +html_theme = "sphinx_scylladb_theme" +html_theme_path = ["../../sphinx-scylladb-theme"] + +html_theme_options = { + "hide_sidebar_index": "true", + "conf_py_path": "docs/source/", + "banner_button_text": "Learn more", + "banner_button_url": "https://docs.start9.com/latest", + "banner_icon_path": "_static/logo.png", + "banner_title_text": "Start9 Docs 0.3.0 is now released 🥳", + "hide_edit_this_page_button": "false", + "hide_sidebar_index": "true", + "hide_banner": "true", + "hide_version_dropdown": ["master"], + "github_issues_repository": "Start9Labs/documentation", + "github_repository": "Start9Labs/documentation", + "site_description": "Start9 Product Documentation and Education Guides", +} + + +# Last updated format +html_last_updated_fmt = "%d %b %Y" + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# Custom sidebar templates, maps document names to template names. +html_sidebars = {"**": ["side-nav.html"]} + +# Output file base name for HTML help builder. +htmlhelp_basename = "Start9Documentationdoc" + +# URL which points to the root of the HTML documentation. +html_baseurl = "https://docs.start9.com" + +# Dictionary of values to pass into the template engine’s context for all pages +html_context = {"html_baseurl": html_baseurl} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +html_logo = "_static/logo.png" + +html_title = "Docs" + +html_favicon = "_static/favicon.ico" \ No newline at end of file diff --git a/source/contributing/embassyos.rst b/site/source/contributing/embassyos.rst similarity index 100% rename from source/contributing/embassyos.rst rename to site/source/contributing/embassyos.rst diff --git a/site/source/contributing/index.rst b/site/source/contributing/index.rst new file mode 100644 index 0000000..b1f0bab --- /dev/null +++ b/site/source/contributing/index.rst @@ -0,0 +1,17 @@ +Contributing +============ + +.. toctree:: + :maxdepth: 2 + :hidden: + + embassyos + services/index + +.. panel-box:: + :title: Overview + :id: contributing + :class: my-panel + + * :doc:`Developer Contributions ` - Learn how you can contribute to EmbassyOS + * :doc:`Service Packaging Guide ` - Learn more about packaging services for EmbassyOS \ No newline at end of file diff --git a/source/contributing/services/backups.rst b/site/source/contributing/services/backups.rst similarity index 100% rename from source/contributing/services/backups.rst rename to site/source/contributing/services/backups.rst diff --git a/source/contributing/services/config.rst b/site/source/contributing/services/config.rst similarity index 100% rename from source/contributing/services/config.rst rename to site/source/contributing/services/config.rst diff --git a/source/contributing/services/docker.rst b/site/source/contributing/services/docker.rst similarity index 100% rename from source/contributing/services/docker.rst rename to site/source/contributing/services/docker.rst diff --git a/source/contributing/services/index.rst b/site/source/contributing/services/index.rst similarity index 100% rename from source/contributing/services/index.rst rename to site/source/contributing/services/index.rst diff --git a/source/contributing/services/instructions.rst b/site/source/contributing/services/instructions.rst similarity index 100% rename from source/contributing/services/instructions.rst rename to site/source/contributing/services/instructions.rst diff --git a/source/contributing/services/makefile.rst b/site/source/contributing/services/makefile.rst similarity index 100% rename from source/contributing/services/makefile.rst rename to site/source/contributing/services/makefile.rst diff --git a/source/contributing/services/manifest.rst b/site/source/contributing/services/manifest.rst similarity index 100% rename from source/contributing/services/manifest.rst rename to site/source/contributing/services/manifest.rst diff --git a/source/contributing/services/overview.rst b/site/source/contributing/services/overview.rst similarity index 100% rename from source/contributing/services/overview.rst rename to site/source/contributing/services/overview.rst diff --git a/source/contributing/services/properties.rst b/site/source/contributing/services/properties.rst similarity index 100% rename from source/contributing/services/properties.rst rename to site/source/contributing/services/properties.rst diff --git a/source/contributing/services/wrapper.rst b/site/source/contributing/services/wrapper.rst similarity index 100% rename from source/contributing/services/wrapper.rst rename to site/source/contributing/services/wrapper.rst diff --git a/source/getting-started/diy.rst b/site/source/getting-started/diy.rst similarity index 100% rename from source/getting-started/diy.rst rename to site/source/getting-started/diy.rst diff --git a/site/source/getting-started/index.rst b/site/source/getting-started/index.rst new file mode 100644 index 0000000..943051f --- /dev/null +++ b/site/source/getting-started/index.rst @@ -0,0 +1,19 @@ +Getting Started +=============== + +.. toctree:: + :maxdepth: 2 + :hidden: + + introduction + purchasing + diy + +.. panel-box:: + :title: Overview + :id: "getting-started" + :class: my-panel + + * :doc:`Introduction ` - Welcome to the future of sovereign computing + * :doc:`Purchasing ` - Ways to acquire an Embassy or EmbassyOS + * :doc:`DIY Guide ` - A guide on building your own Embassy \ No newline at end of file diff --git a/source/getting-started/introduction.rst b/site/source/getting-started/introduction.rst similarity index 100% rename from source/getting-started/introduction.rst rename to site/source/getting-started/introduction.rst diff --git a/source/getting-started/purchasing.rst b/site/source/getting-started/purchasing.rst similarity index 100% rename from source/getting-started/purchasing.rst rename to site/source/getting-started/purchasing.rst diff --git a/site/source/index.rst b/site/source/index.rst new file mode 100644 index 0000000..0956ae7 --- /dev/null +++ b/site/source/index.rst @@ -0,0 +1,98 @@ +.. title:: Start9 Documentation + +.. raw:: html + +
+ +.. hero-box:: + :title: Documentation + :button_icon: scylla-icon scylla-icon--monitoring + :image: /_static/img/docs_icon.svg + + 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: Guides + :link: getting-started + :icon: scylla-icon scylla-icon--knowledge-base + :class: large-6 + :anchor: View + + Read the documentation + + +.. topic-box:: + :title: User Manual + :link: user-manual + :icon: scylla-icon scylla-icon--integrations + :class: large-6 + :anchor: View + + Get started with your Embassy + +.. topic-box:: + :title: Support + :link: support + :icon: scylla-icon scylla-icon--support + :class: large-6 + :anchor: Get help + + Find answers to your questions + +.. topic-box:: + :title: Contribute + :link: contributing + :icon: scylla-icon scylla-icon--apps + :class: large-6 + :anchor: Get started + + Read our FAQ and learn about platform concepts + +.. .. topic-box:: +.. :title: Learn +.. :link: support/FAQ +.. :icon: scylla-icon scylla-icon--webinars +.. :class: large-6 +.. :anchor: Get started + +.. Read our FAQ and learn about platform concepts + +.. .. topic-box:: +.. :title: Purchasing +.. :link: https://store.start9.com +.. :icon: scylla-icon scylla-icon--bitcoin +.. :class: large-4 +.. :anchor: Buy now + +.. Learn about how you can purchase Start9 products + +.. .. topic-box:: +.. :title: Build your own +.. :link: user-manual/tuning/diy +.. :icon: scylla-icon scylla-icon--integrations +.. :class: large-4 +.. :anchor: Get started + +.. Build from source with our DIY guide + + +.. This is for the side navigation display +.. toctree:: + :maxdepth: 2 + :hidden: + + getting-started/index + user-manual/index + misc-guides/index + contributing/index + support/index \ No newline at end of file diff --git a/source/misc-guides/available-services.rst b/site/source/misc-guides/available-services.rst similarity index 100% rename from source/misc-guides/available-services.rst rename to site/source/misc-guides/available-services.rst diff --git a/source/misc-guides/bitcoin-cli.rst b/site/source/misc-guides/bitcoin-cli.rst similarity index 100% rename from source/misc-guides/bitcoin-cli.rst rename to site/source/misc-guides/bitcoin-cli.rst diff --git a/site/source/misc-guides/index.rst b/site/source/misc-guides/index.rst new file mode 100644 index 0000000..6a175c6 --- /dev/null +++ b/site/source/misc-guides/index.rst @@ -0,0 +1,21 @@ +Miscellaneous Guides +==================== + +.. toctree:: + :maxdepth: 2 + :hidden: + + tor-os/index + tor-firefox/index + available-services + bitcoin-cli + +.. panel-box:: + :title: Overview + :id: "misc-guides" + :class: my-panel + + * :doc:`Tor for your computer ` - A guide on how to run Tor on your computer's operating system + * :doc:`Tor for Firefox ` - A guide on how to configure Tor for Firefox browser + * :doc:`Bitcoin CLI ` - Steps on how to access the command line interface of bitcoind on your Embassy + * :doc:`Available services ` - A comprehensive list of services currently offered on EmbassyOS \ No newline at end of file diff --git a/source/misc-guides/tor-firefox/android.rst b/site/source/misc-guides/tor-firefox/android.rst similarity index 100% rename from source/misc-guides/tor-firefox/android.rst rename to site/source/misc-guides/tor-firefox/android.rst diff --git a/source/misc-guides/tor-firefox/desktop.rst b/site/source/misc-guides/tor-firefox/desktop.rst similarity index 100% rename from source/misc-guides/tor-firefox/desktop.rst rename to site/source/misc-guides/tor-firefox/desktop.rst diff --git a/source/misc-guides/tor-firefox/index.rst b/site/source/misc-guides/tor-firefox/index.rst similarity index 100% rename from source/misc-guides/tor-firefox/index.rst rename to site/source/misc-guides/tor-firefox/index.rst diff --git a/source/misc-guides/tor-firefox/ios.rst b/site/source/misc-guides/tor-firefox/ios.rst similarity index 100% rename from source/misc-guides/tor-firefox/ios.rst rename to site/source/misc-guides/tor-firefox/ios.rst diff --git a/source/misc-guides/tor-firefox/mobile.rst b/site/source/misc-guides/tor-firefox/mobile.rst similarity index 100% rename from source/misc-guides/tor-firefox/mobile.rst rename to site/source/misc-guides/tor-firefox/mobile.rst diff --git a/source/misc-guides/tor-os/android.rst b/site/source/misc-guides/tor-os/android.rst similarity index 100% rename from source/misc-guides/tor-os/android.rst rename to site/source/misc-guides/tor-os/android.rst diff --git a/source/misc-guides/tor-os/index.rst b/site/source/misc-guides/tor-os/index.rst similarity index 100% rename from source/misc-guides/tor-os/index.rst rename to site/source/misc-guides/tor-os/index.rst diff --git a/source/misc-guides/tor-os/ios.rst b/site/source/misc-guides/tor-os/ios.rst similarity index 100% rename from source/misc-guides/tor-os/ios.rst rename to site/source/misc-guides/tor-os/ios.rst diff --git a/source/misc-guides/tor-os/linux.rst b/site/source/misc-guides/tor-os/linux.rst similarity index 100% rename from source/misc-guides/tor-os/linux.rst rename to site/source/misc-guides/tor-os/linux.rst diff --git a/source/misc-guides/tor-os/mac.rst b/site/source/misc-guides/tor-os/mac.rst similarity index 100% rename from source/misc-guides/tor-os/mac.rst rename to site/source/misc-guides/tor-os/mac.rst diff --git a/source/misc-guides/tor-os/windows.rst b/site/source/misc-guides/tor-os/windows.rst similarity index 100% rename from source/misc-guides/tor-os/windows.rst rename to site/source/misc-guides/tor-os/windows.rst diff --git a/source/support/FAQ/030-faq.rst b/site/source/support/FAQ/030-faq.rst similarity index 100% rename from source/support/FAQ/030-faq.rst rename to site/source/support/FAQ/030-faq.rst diff --git a/source/support/FAQ/bitcoin-faq.rst b/site/source/support/FAQ/bitcoin-faq.rst similarity index 100% rename from source/support/FAQ/bitcoin-faq.rst rename to site/source/support/FAQ/bitcoin-faq.rst diff --git a/source/support/FAQ/dev-faq.rst b/site/source/support/FAQ/dev-faq.rst similarity index 100% rename from source/support/FAQ/dev-faq.rst rename to site/source/support/FAQ/dev-faq.rst diff --git a/source/support/FAQ/embassy-faq.rst b/site/source/support/FAQ/embassy-faq.rst similarity index 100% rename from source/support/FAQ/embassy-faq.rst rename to site/source/support/FAQ/embassy-faq.rst diff --git a/source/support/FAQ/general-faq.rst b/site/source/support/FAQ/general-faq.rst similarity index 100% rename from source/support/FAQ/general-faq.rst rename to site/source/support/FAQ/general-faq.rst diff --git a/source/support/FAQ/index.rst b/site/source/support/FAQ/index.rst similarity index 100% rename from source/support/FAQ/index.rst rename to site/source/support/FAQ/index.rst diff --git a/source/support/FAQ/services-faq.rst b/site/source/support/FAQ/services-faq.rst similarity index 100% rename from source/support/FAQ/services-faq.rst rename to site/source/support/FAQ/services-faq.rst diff --git a/source/support/FAQ/setup-faq.rst b/site/source/support/FAQ/setup-faq.rst similarity index 100% rename from source/support/FAQ/setup-faq.rst rename to site/source/support/FAQ/setup-faq.rst diff --git a/source/support/FAQ/usage-faq.rst b/site/source/support/FAQ/usage-faq.rst similarity index 100% rename from source/support/FAQ/usage-faq.rst rename to site/source/support/FAQ/usage-faq.rst diff --git a/source/support/concepts.rst b/site/source/support/concepts.rst similarity index 100% rename from source/support/concepts.rst rename to site/source/support/concepts.rst diff --git a/source/support/contact.rst b/site/source/support/contact.rst similarity index 100% rename from source/support/contact.rst rename to site/source/support/contact.rst diff --git a/site/source/support/index.rst b/site/source/support/index.rst new file mode 100644 index 0000000..673fd19 --- /dev/null +++ b/site/source/support/index.rst @@ -0,0 +1,19 @@ +Support +======= + +.. toctree:: + :maxdepth: 2 + :hidden: + + FAQ/index + concepts + contact + +.. panel-box:: + :title: Overview + :id: support + :class: my-panel + + * :doc:`FAQ ` - Comprehensive source of Frequently Asked Questions + * :doc:`Concepts ` - Familiarize yourself with concepts related to EmbassyOS + * :doc:`Contact ` - Get in touch with further questions \ No newline at end of file diff --git a/source/user-manual/connecting.rst b/site/source/user-manual/connecting.rst similarity index 100% rename from source/user-manual/connecting.rst rename to site/source/user-manual/connecting.rst diff --git a/source/user-manual/general/developer-options/alt-marketplace.rst b/site/source/user-manual/general/developer-options/alt-marketplace.rst similarity index 100% rename from source/user-manual/general/developer-options/alt-marketplace.rst rename to site/source/user-manual/general/developer-options/alt-marketplace.rst diff --git a/source/user-manual/general/developer-options/index.rst b/site/source/user-manual/general/developer-options/index.rst similarity index 100% rename from source/user-manual/general/developer-options/index.rst rename to site/source/user-manual/general/developer-options/index.rst diff --git a/source/user-manual/general/developer-options/ssh-setup.rst b/site/source/user-manual/general/developer-options/ssh-setup.rst similarity index 100% rename from source/user-manual/general/developer-options/ssh-setup.rst rename to site/source/user-manual/general/developer-options/ssh-setup.rst diff --git a/source/user-manual/general/embassy-config.rst b/site/source/user-manual/general/embassy-config.rst similarity index 100% rename from source/user-manual/general/embassy-config.rst rename to site/source/user-manual/general/embassy-config.rst diff --git a/source/user-manual/general/forgot-password.rst b/site/source/user-manual/general/forgot-password.rst similarity index 100% rename from source/user-manual/general/forgot-password.rst rename to site/source/user-manual/general/forgot-password.rst diff --git a/source/user-manual/general/index.rst b/site/source/user-manual/general/index.rst similarity index 100% rename from source/user-manual/general/index.rst rename to site/source/user-manual/general/index.rst diff --git a/source/user-manual/general/lan-setup/browser-setup.rst b/site/source/user-manual/general/lan-setup/browser-setup.rst similarity index 100% rename from source/user-manual/general/lan-setup/browser-setup.rst rename to site/source/user-manual/general/lan-setup/browser-setup.rst diff --git a/source/user-manual/general/lan-setup/computer-setup.rst b/site/source/user-manual/general/lan-setup/computer-setup.rst similarity index 100% rename from source/user-manual/general/lan-setup/computer-setup.rst rename to site/source/user-manual/general/lan-setup/computer-setup.rst diff --git a/source/user-manual/general/lan-setup/desktop.rst b/site/source/user-manual/general/lan-setup/desktop.rst similarity index 100% rename from source/user-manual/general/lan-setup/desktop.rst rename to site/source/user-manual/general/lan-setup/desktop.rst diff --git a/source/user-manual/general/lan-setup/index.rst b/site/source/user-manual/general/lan-setup/index.rst similarity index 100% rename from source/user-manual/general/lan-setup/index.rst rename to site/source/user-manual/general/lan-setup/index.rst diff --git a/source/user-manual/general/lan-setup/mobile.rst b/site/source/user-manual/general/lan-setup/mobile.rst similarity index 100% rename from source/user-manual/general/lan-setup/mobile.rst rename to site/source/user-manual/general/lan-setup/mobile.rst diff --git a/source/user-manual/general/notifications.rst b/site/source/user-manual/general/notifications.rst similarity index 100% rename from source/user-manual/general/notifications.rst rename to site/source/user-manual/general/notifications.rst diff --git a/source/user-manual/general/power.rst b/site/source/user-manual/general/power.rst similarity index 100% rename from source/user-manual/general/power.rst rename to site/source/user-manual/general/power.rst diff --git a/source/user-manual/general/updating.rst b/site/source/user-manual/general/updating.rst similarity index 100% rename from source/user-manual/general/updating.rst rename to site/source/user-manual/general/updating.rst diff --git a/source/user-manual/general/wifi.rst b/site/source/user-manual/general/wifi.rst similarity index 100% rename from source/user-manual/general/wifi.rst rename to site/source/user-manual/general/wifi.rst diff --git a/site/source/user-manual/index.rst b/site/source/user-manual/index.rst new file mode 100644 index 0000000..e41c713 --- /dev/null +++ b/site/source/user-manual/index.rst @@ -0,0 +1,21 @@ +User Manual +============ + +.. toctree:: + :maxdepth: 2 + :hidden: + + general/index + managing-services/index + connecting + initial-setup + +.. panel-box:: + :title: Overview + :id: "user-manual" + :class: my-panel + + * :doc:`Initial Setup ` - How to setup your Embassy + * :doc:`Connecting ` - Ways to connect to your Embassy + * :doc:`Managing Services ` - Working with the open source projects made compatible for the Embassy + * :doc:`General ` - An overview of EmbassyOS general capabilities \ No newline at end of file diff --git a/source/user-manual/initial-setup.rst b/site/source/user-manual/initial-setup.rst similarity index 100% rename from source/user-manual/initial-setup.rst rename to site/source/user-manual/initial-setup.rst diff --git a/source/user-manual/managing-services/backups.rst b/site/source/user-manual/managing-services/backups.rst similarity index 100% rename from source/user-manual/managing-services/backups.rst rename to site/source/user-manual/managing-services/backups.rst diff --git a/source/user-manual/managing-services/index.rst b/site/source/user-manual/managing-services/index.rst similarity index 100% rename from source/user-manual/managing-services/index.rst rename to site/source/user-manual/managing-services/index.rst diff --git a/source/user-manual/managing-services/installing.rst b/site/source/user-manual/managing-services/installing.rst similarity index 100% rename from source/user-manual/managing-services/installing.rst rename to site/source/user-manual/managing-services/installing.rst diff --git a/source/user-manual/managing-services/instructions.rst b/site/source/user-manual/managing-services/instructions.rst similarity index 100% rename from source/user-manual/managing-services/instructions.rst rename to site/source/user-manual/managing-services/instructions.rst diff --git a/source/user-manual/managing-services/logs.rst b/site/source/user-manual/managing-services/logs.rst similarity index 100% rename from source/user-manual/managing-services/logs.rst rename to site/source/user-manual/managing-services/logs.rst diff --git a/source/user-manual/managing-services/managing-deps.rst b/site/source/user-manual/managing-services/managing-deps.rst similarity index 100% rename from source/user-manual/managing-services/managing-deps.rst rename to site/source/user-manual/managing-services/managing-deps.rst diff --git a/source/user-manual/managing-services/properties.rst b/site/source/user-manual/managing-services/properties.rst similarity index 100% rename from source/user-manual/managing-services/properties.rst rename to site/source/user-manual/managing-services/properties.rst diff --git a/source/user-manual/managing-services/service-config.rst b/site/source/user-manual/managing-services/service-config.rst similarity index 100% rename from source/user-manual/managing-services/service-config.rst rename to site/source/user-manual/managing-services/service-config.rst diff --git a/source/_static/default.css b/source/_static/default.css deleted file mode 100644 index 66e165c..0000000 --- a/source/_static/default.css +++ /dev/null @@ -1,194 +0,0 @@ -body, p, h1, h2, h3, h4, nav, .topbar, .topbar-main, .tocsection, .form-control, .bd-toc, .bd-sidebar { - background-color: #2b2b2b!important; - color: #f8f8ff!important; - line-height: 1.65; -} - -h1 { - font-size: 2rem; - margin-top: 3.5rem; -} - -h2 { - font-size: 1.5rem; -} - -h3 { - font-size: 1.25rem; -} - -h4 { - font-size: 1.15rem; -} - -p, nav a { - font-size: 1.1em; - letter-spacing: 0.75px; -} - -a, a:visited, .headerlink { - color: #ff4961!important; -} - -.bd-toc nav li.active>a.active { - border-left: 2px solid #ff4961!important;; -} - -.prev-next-bottom a.left-prev, .prev-next-bottom a.right-next { - border: 1px solid #f8f8ff; -} - -.input:focus { - outline: none !important; - border:1px solid #ff4961!important; - box-shadow: 0 0 10px #ff4961!important; -} - -h1, h2 { - /* border-bottom: 1px solid #666!important; - padding-bottom: 0.5rem!important; */ - /* font-variant: small-caps; */ - letter-spacing: 2.3px; - -} - -.admonition.warning .admonition-title, .admonition.note .admonition-title { - background-color: #666; -} - -.important .admonition-title { - background-color: none!important; -} - -.header-style:before, h1:before, h2:before, h3:before, h4:before, h5:before, h6:before { - display: inline; -} - -.bd-sidebar { - background: none; -} - -@media (min-width: 768px) { - .bd-sidebar { - border-right: 0.5px solid #f8f8ff; - background: none; - } -} - - -a:active { - text-decoration: none; -} - -ul.current > .current .active > a.current { - text-decoration: underline #f8f8ff; -} - -@media (max-width: 768px) { - #site-navigation { - background-color: #2b2b2b; - } -} - -code { - color: #ff4961!important; -} - -.topbar .topbar-main button.topbarbtn { - background-color: #2b2b2b; - color: #ff4960; -} - -@media (min-width: 1200px){ - .container, .container-lg, .container-md, .container-sm, .container-xl { - max-width: 2200px; - } -} - -.container-fluid, .container-lg, .container-md, .container-sm, .container-xl { - width: 90%; -} - -.admonition { - width: 80%; -} - -/* TOGGLE */ - -.toggle .admonition { - padding-bottom: 0px!important; -} - -.toggle .admonition-title { - display: block; - clear: both; - cursor: pointer; -} - -.toggle .admonition-title::after { - content: " â–¶"; -} - -.toggle .admonition-title.open::after { - content: " â–¼"; -} - -.expand { - width: 75%; - margin: 1em 0 1em 5em; - padding: 0 .6rem 0rem!important; - border-left: .2rem solid #393838!important; - box-shadow: 0 0.2rem 0.5rem rgba(0,0,0,.05), 0 0 0.05rem rgba(0,0,0,.1); - transition: color .25s,background-color .25s,border-color .25s; -} - -.expand .admonition-title { - background-color: #1e1e1e; - font-weight: 300; -} - -.expand .admonition-title:before { - color: #393838!important; -} - -@media (max-width: 600px) { - .expand { - width: 90%; - margin: 0 0 1em 1.5em; - } -} - -.caption > i { - display: none; -} - -nav.bd-links .fa-chevron-up:hover, nav.bd-links .fa-chevron-down:hover { - color: #ff4960; -} - -nav.bd-links > ul.nav { - padding-right: 8px; -} - -.highlight > pre { - background-color: lightgray; -} - -.set-padding { - padding-top: 75px!important; -} - -/* MISC */ - -.hidden { - display: none!important; -} - -.navbar-brand-box a.navbar-brand { - width: 75%; - height: auto; -} - -.navbar-brand-box { - text-align: center; -} \ No newline at end of file diff --git a/source/_static/favicon.ico b/source/_static/favicon.ico deleted file mode 100644 index 928a049..0000000 Binary files a/source/_static/favicon.ico and /dev/null differ diff --git a/source/_static/js/main.js b/source/_static/js/main.js deleted file mode 100644 index e6c1388..0000000 --- a/source/_static/js/main.js +++ /dev/null @@ -1,30 +0,0 @@ -$(document).ready(function (e) { - // open external links in separate tab - $('a[href^="http://"], a[href^="https://"]').not('a[class*=internal]').attr('target', '_blank'); - - // toggle hidable sections - $(".toggle > *").hide(); - $(".toggle .admonition-title").show(); - $(".toggle .admonition-title").click(function() { - $(this).parent().children().not(".admonition-title").toggle(400); - $(this).parent().children(".admonition-title").toggleClass("open"); - }) - - // change appearance of arrow to X for menu closing - $(".fa-arrow-left").attr("class", "fas fa-times"); - $(".fa-arrow-up").attr("class", "fas fa-times"); - - // initially hide menu close button on small screen widths - if ($(window).width() < 768) { - $('.fa-times').addClass('hidden'); - } - - $('#navbar-toggler').click(function() { - // toggle menu open/close button depending on collapsed state - if ($('#navbar-toggler').hasClass("collapsed")) { - $('.fa-times').removeClass('hidden'); - } else { - $('.fa-times').addClass('hidden'); - } - }); -}); diff --git a/source/_templates/versioning.html b/source/_templates/versioning.html deleted file mode 100644 index a1d0902..0000000 --- a/source/_templates/versioning.html +++ /dev/null @@ -1,15 +0,0 @@ -{% if versions %} -

{{ _('Branches') }}

-
    - {%- for item in versions.branches %} -
  • {{ item.name }}
  • - {%- endfor %} -
-

{{ _('Tags') }}

- -{% endif %} - diff --git a/source/conf.py b/source/conf.py deleted file mode 100644 index 46759a5..0000000 --- a/source/conf.py +++ /dev/null @@ -1,103 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - -# -- Project information ----------------------------------------------------- - -project = 'Start9 Docs' -copyright = '2021, Start9 Labs, Inc' - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinxcontrib.yt', - 'sphinx_multiversion' - # 'sphinxcontrib.needs' -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# HTML sidebar widgets -html_sidebars = { - "**": ["sidebar-logo.html", "search-field.html", "versioning.html", "sbt-sidebar-nav.html", "sbt-sidebar-footer.html"] -} - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] - -# Multiversion settings -# Whitelist pattern for tags (set to None to ignore all tags) -smv_tag_whitelist = r'^v\d+\.\d+$' # Include tags like "v2.1" - -# Whitelist pattern for branches (set to None to ignore all branches) -smv_branch_whitelist = r'^.*$' - -# Whitelist pattern for remotes (set to None to use local branches only) -smv_remote_whitelist = r'^(origin)$' - -# Pattern for released versions -smv_released_pattern = r'^tags/.*$' - -# Format for versioned output directories inside the build directory -smv_outputdir_format = 'versions/{ref.name}' - -# Determines whether remote or local git branches/tags are preferred if their output dirs conflict -smv_prefer_remote_refs = True - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. - -html_theme = 'sphinx_book_theme' -html_copy_source = True -html_last_updated_fmt = "" - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -html_theme_options = { - # "theme_dev_mode": True, - "path_to_docs": "source", - "repository_url": "https://github.com/Start9Labs/documentation", - "repository_branch": "master", - "use_edit_page_button": True, - "use_issues_button": True, - "use_repository_button": True, - "extra_navbar": "Powered by Start9", # Will be displayed underneath the left navbar" - "show_navbar_depth": 1, - "use_download_button": True, - "use_edit_page_button": True, - "launch_buttons": { - "main_site": "https://start9.com", - }, -} -html_logo = "_static/logo.png" -html_title = "Docs" -html_favicon = "_static/favicon.ico" -html_js_files = [ - 'js/main.js' -] -html_cs_files = [ - 'default.css' -] diff --git a/source/index.rst b/source/index.rst deleted file mode 100644 index bccec33..0000000 --- a/source/index.rst +++ /dev/null @@ -1,48 +0,0 @@ -#################### -Start9 Documentation -#################### - -Welcome to the docs! - -Here you will find guidance and information about the Start9 Embassy personal server and its operating system, EmbassyOS. If you identify an error with the docs or would like to contribute to them, please use the GitHub link at the top of this page. - -.. toctree:: - :maxdepth: 2 - :caption: Getting Started - - getting-started/introduction - getting-started/purchasing - getting-started/diy - -.. toctree:: - :maxdepth: 2 - :caption: User Manual - - user-manual/initial-setup - user-manual/connecting - user-manual/general/index - user-manual/managing-services/index - -.. toctree:: - :maxdepth: 2 - :caption: Misc Guides - - misc-guides/available-services - misc-guides/bitcoin-cli - misc-guides/tor-os/index - misc-guides/tor-firefox/index - -.. toctree:: - :maxdepth: 2 - :caption: Contributing - - contributing/services/index - contributing/embassyos - -.. toctree:: - :maxdepth: 2 - :caption: Support - - support/FAQ/index - support/concepts - support/contact \ No newline at end of file diff --git a/sphinx-scylladb-theme b/sphinx-scylladb-theme new file mode 160000 index 0000000..80a78f1 --- /dev/null +++ b/sphinx-scylladb-theme @@ -0,0 +1 @@ +Subproject commit 80a78f1d82206dcf2249f4f984999c8e98a5ca06