diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f89fc906..ccf554eb 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,6 +14,8 @@ build: # nodejs: "19" # rust: "1.64" # golang: "1.19" + apt_packages: + - kicad # Build documentation in the "docs/" directory with Sphinx sphinx: diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..a485625d --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +/_build diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..7b939bfc --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,5 @@ +all: + sphinx-build -M html . _build + +autobuild: + sphinx-autobuild . _build/html diff --git a/docs/about/index.rst b/docs/about/index.rst new file mode 100644 index 00000000..189447d1 --- /dev/null +++ b/docs/about/index.rst @@ -0,0 +1,7 @@ +По проєкт +=========== + +.. toctree:: + :maxdepth: 2 + + what_is_lilka diff --git a/docs/about/what_is_lilka.rst b/docs/about/what_is_lilka.rst new file mode 100644 index 00000000..249d3551 --- /dev/null +++ b/docs/about/what_is_lilka.rst @@ -0,0 +1,3 @@ +Що таке Лілка? +============== + diff --git a/docs/conf.py b/docs/conf.py index f3891478..0901f02c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,22 +6,25 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'Lilka' -copyright = '2024, Andrew Dunai' -author = 'Andrew Dunai' +project = "Lilka" +copyright = "2024, Andrew Dunai" +author = "Andrew Dunai" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [] -templates_path = ['_templates'] -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +templates_path = ["_templates"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] -language = 'uk_UA' +language = "uk_UA" # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'alabaster' -html_static_path = ['_static'] +html_theme = "sphinx_rtd_theme" +html_static_path = ["_static"] +html_theme_options = { + "collapse_navigation": False, +} diff --git a/docs/hardware/index.rst b/docs/hardware/index.rst new file mode 100644 index 00000000..2f427f2d --- /dev/null +++ b/docs/hardware/index.rst @@ -0,0 +1,8 @@ +Апаратна частина +================ + +.. toctree:: + :maxdepth: 2 + :caption: Зміст + + schematics_v2 diff --git a/docs/hardware/schematics_v2.rst b/docs/hardware/schematics_v2.rst new file mode 100644 index 00000000..c513f44f --- /dev/null +++ b/docs/hardware/schematics_v2.rst @@ -0,0 +1,2 @@ +Креслення (v2) +============== diff --git a/docs/index.rst b/docs/index.rst index 95323388..376493bd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,12 +3,15 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Lilka's documentation! -================================= +Вітаємо вас у документації проекту Lilka! +========================================= .. toctree:: - :maxdepth: 2 - :caption: Contents: + :maxdepth: 2 + :caption: Зміст: + + about/index + hardware/index diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 32bb2452..00000000 --- a/docs/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=. -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