add docs
All checks were successful
Test Actions / Builder (push) Successful in 12s

This commit is contained in:
2025-10-19 00:10:25 +03:00
parent 49a26f2a63
commit 88318596ab
5 changed files with 128 additions and 0 deletions

20
docs/Makefile Normal file
View File

@@ -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 = 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)

2
docs/build/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*
!.gitignore

28
docs/source/conf.py Normal file
View File

@@ -0,0 +1,28 @@
# 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 = 'actions/tools'
copyright = '2025, RemiZOffAlex'
author = 'RemiZOffAlex'
release = '0.1'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = []
templates_path = ['_templates']
exclude_patterns = []
language = 'ru'
# -- 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']

View File

@@ -0,0 +1,61 @@
GITHUB_WORKSPACE=/workspace/actions/tools
HOSTNAME=2b1fa93ba1fb
GITHUB_PATH=/var/run/act/workflow/pathcmd.txt
GITHUB_ACTION=0
GITHUB_RUN_NUMBER=39
GITEA_ACTIONS=true
DISTTAG=f42container
GITHUB_REF_TYPE=branch
ACTIONS_CACHE_URL=http://10.20.30.40:5000/
PWD=/workspace/actions/tools
GITHUB_ACTIONS=true
GITHUB_SHA=8433e0907aa38aef59e7f49532bec14ed787cc49
FBR=f42
JOB_CONTAINER_NAME=GITEA-ACTIONS-TASK-858_WORKFLOW-Test-Actions_JOB-Builder
GITHUB_REF=refs/heads/master
ACT=true
RUNNER_OS=Linux
HOME=/root
GITHUB_API_URL=https://codex.r10x.net/api/v1
LANG=C.UTF-8
RUNNER_TRACKING_ID=
FGC=f42
RUNNER_ARCH=X64
INPUT_REF=
RUNNER_TEMP=/tmp
ACTIONS_RUNTIME_URL=https://codex.r10x.net/api/actions_pipeline/
GITEA_ACTIONS_RUNNER_VERSION=v0.2.10
GITHUB_STATE=/var/run/act/workflow/statecmd.txt
GITHUB_ENV=/var/run/act/workflow/envs.txt
GITHUB_EVENT_PATH=/var/run/act/workflow/event.json
GITHUB_EVENT_NAME=push
GITHUB_RUN_ID=850
INPUT_TOKEN=***
GITHUB_STEP_SUMMARY=/var/run/act/workflow/SUMMARY.md
GITHUB_ACTOR=RemiZOffAlex
ACTIONS_RESULTS_URL=https://codex.r10x.net
INPUT_REPOSITORY=actions/tools
GITHUB_GRAPHQL_URL=
ACTIONS_RUNTIME_TOKEN=***
GITHUB_ACTION_PATH=/var/run/act/actions/https---codex.r10x.net-actions-tools@master
GITHUB_SERVER_URL=https://codex.r10x.net
SHLVL=1
RUNNER_TOOL_CACHE=/opt/hostedtoolcache
GITHUB_REF_NAME=master
GITHUB_JOB=Builder
A_TEST_ENV_NAME_1=a_test_env_value_1
A_TEST_ENV_NAME_2=a_test_env_value_2
GITHUB_REPOSITORY=actions/tools
GITHUB_RETENTION_DAYS=
GITHUB_ACTION_REPOSITORY=actions/tools
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
RUNNER_PERFLOG=/dev/null
GITHUB_BASE_REF=
CI=true
ImageOS=toolchain
GITHUB_REPOSITORY_OWNER=actions
GITHUB_HEAD_REF=
GITHUB_ACTION_REF=master
GITHUB_WORKFLOW=Test Actions
GITHUB_OUTPUT=/var/run/act/workflow/outputcmd.txt
_=/usr/sbin/env

17
docs/source/index.rst Normal file
View File

@@ -0,0 +1,17 @@
.. actions/tools documentation master file, created by
sphinx-quickstart on Sun Oct 19 00:08:43 2025.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
actions/tools documentation
===========================
Add your content using ``reStructuredText`` syntax. See the
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
documentation for details.
.. toctree::
:maxdepth: 2
:caption: Contents: