Merge pull request #65 from SerhiiYahdzhyiev/docs

Added sphinx-js to the project.

.gitignore

@@ -2,3 +2,5 @@ node_modules/
 **.lock
 build/
 dist/
+
+docs/_build

docs/Makefile

@@ -0,0 +1,20 @@
+# 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     = .
+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)

docs/api/env.rst

@@ -0,0 +1,4 @@
+Environment
+===========
+
+.. autofunction:: getEnvType

docs/api/index.rst

@@ -0,0 +1,8 @@
+API Documentation
+=================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   Environment <env>

docs/conf.py

@@ -0,0 +1,31 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Tabs Manager'
+copyright = '2024, Serhii Yahdzhyiev'
+author = 'Serhii Yahdzhyiev'
+release = '0.1.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["sphinx_js"]
+js_language = "javascript"
+js_source_path = "../build/"
+
+primary_domain = "js"
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_show_sourcelink = False
+html_show_sphinx = False

docs/index.rst

@@ -0,0 +1,11 @@
+.. Tabs Manager documentation master file, created by
+   sphinx-quickstart on Tue Oct  8 10:30:57 2024.
+
+Tabs Manager Documentation
+==========================
+
+.. toctree::
+   :maxdepth: 1
+
+   API Docs <api/index>
+

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

src/env.ts

@@ -5,6 +5,11 @@ declare let browser: {
   runtime: typeof chrome.runtime;
 };
 
+/**
+ * Return the type of environment.
+ *
+ * @returns {EnvironmentType} "worker" | "window" | "invalid"
+ */
 export function getEnvType(): EnvironmentType {
   const gThis = String(globalThis);
   if (gThis.match(/worker/gi)) {