Read the Docs build information
Build id: 2647875
Project: metalsoft-metalsoft-docs
Version: latest
Commit: ce89ce5d502ebd306ed930a60ec071783f7d8f13
Date: 2024-11-28T09:14:18.562011Z
State: cancelled
Success: False


[rtd-command-info] start-time: 2024-11-28T09:14:19.806820Z, end-time: 2024-11-28T09:14:24.759090Z, duration: 4, exit-code: 0
git clone --depth 1 git@github.com:metalsoft-io/metalsoft-docs.git .
Cloning into '.'...
Warning: Permanently added 'github.com' (ED25519) to the list of known hosts.

[rtd-command-info] start-time: 2024-11-28T09:14:24.834082Z, end-time: 2024-11-28T09:14:26.352083Z, duration: 1, exit-code: 0
git fetch origin --force --prune --prune-tags --depth 50 refs/heads/master:refs/remotes/origin/master
Warning: Permanently added 'github.com' (ED25519) to the list of known hosts.

[rtd-command-info] start-time: 2024-11-28T09:14:26.488598Z, end-time: 2024-11-28T09:14:27.174584Z, duration: 0, exit-code: 0
git checkout --force origin/master
Note: switching to 'origin/master'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at ce89ce5 metalcloud-cli remove env vars METALCLOUD_USER_EMAIL & METALCLOUD_ADMIN from example, as these are discovered bia the KEY

[rtd-command-info] start-time: 2024-11-28T09:14:27.245227Z, end-time: 2024-11-28T09:14:27.307188Z, duration: 0, exit-code: 0
cat .readthedocs.yaml
version: 2

build:
 os: ubuntu-22.04
 tools:
    python: "3.11"

python:
   install:
   - requirements: requirements.txt

[rtd-command-info] start-time: 2024-11-28T09:14:34.363770Z, end-time: 2024-11-28T09:14:34.443694Z, duration: 0, exit-code: 0
asdf global python 3.11.10


[rtd-command-info] start-time: 2024-11-28T09:14:34.871708Z, end-time: 2024-11-28T09:14:35.934552Z, duration: 1, exit-code: 0
python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
created virtual environment CPython3.11.10.final.0-64 in 742ms
  creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest, clear=False, no_vcs_ignore=False, global=False)
  seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv)
    added seed packages: pip==23.1, setuptools==67.6.1, wheel==0.40.0
  activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator

[rtd-command-info] start-time: 2024-11-28T09:14:36.005050Z, end-time: 2024-11-28T09:14:48.843492Z, duration: 12, exit-code: 0
python -m pip install --upgrade --no-cache-dir pip setuptools
Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (23.1)
Collecting pip
  Downloading pip-24.3.1-py3-none-any.whl (1.8 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 15.1 MB/s eta 0:00:00
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (67.6.1)
Collecting setuptools
  Downloading setuptools-75.6.0-py3-none-any.whl (1.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 33.2 MB/s eta 0:00:00
Installing collected packages: setuptools, pip
  Attempting uninstall: setuptools
    Found existing installation: setuptools 67.6.1
    Uninstalling setuptools-67.6.1:
      Successfully uninstalled setuptools-67.6.1
  Attempting uninstall: pip
    Found existing installation: pip 23.1
    Uninstalling pip-23.1:
      Successfully uninstalled pip-23.1
Successfully installed pip-24.3.1 setuptools-75.6.0

[rtd-command-info] start-time: 2024-11-28T09:14:48.924889Z, end-time: 2024-11-28T09:14:58.690899Z, duration: 9, exit-code: 0
python -m pip install --upgrade --no-cache-dir sphinx
Collecting sphinx
  Downloading sphinx-8.1.3-py3-none-any.whl.metadata (6.4 kB)
Collecting sphinxcontrib-applehelp>=1.0.7 (from sphinx)
  Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-devhelp>=1.0.6 (from sphinx)
  Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-htmlhelp>=2.0.6 (from sphinx)
  Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-jsmath>=1.0.1 (from sphinx)
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB)
Collecting sphinxcontrib-qthelp>=1.0.6 (from sphinx)
  Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx)
  Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl.metadata (2.4 kB)
Collecting Jinja2>=3.1 (from sphinx)
  Downloading jinja2-3.1.4-py3-none-any.whl.metadata (2.6 kB)
Collecting Pygments>=2.17 (from sphinx)
  Downloading pygments-2.18.0-py3-none-any.whl.metadata (2.5 kB)
Collecting docutils<0.22,>=0.20 (from sphinx)
  Downloading docutils-0.21.2-py3-none-any.whl.metadata (2.8 kB)
Collecting snowballstemmer>=2.2 (from sphinx)
  Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl.metadata (6.5 kB)
Collecting babel>=2.13 (from sphinx)
  Downloading babel-2.16.0-py3-none-any.whl.metadata (1.5 kB)
Collecting alabaster>=0.7.14 (from sphinx)
  Downloading alabaster-1.0.0-py3-none-any.whl.metadata (2.8 kB)
Collecting imagesize>=1.3 (from sphinx)
  Downloading imagesize-1.4.1-py2.py3-none-any.whl.metadata (1.5 kB)
Collecting requests>=2.30.0 (from sphinx)
  Downloading requests-2.32.3-py3-none-any.whl.metadata (4.6 kB)
Collecting packaging>=23.0 (from sphinx)
  Downloading packaging-24.2-py3-none-any.whl.metadata (3.2 kB)
Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx)
  Downloading MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.0 kB)
Collecting charset-normalizer<4,>=2 (from requests>=2.30.0->sphinx)
  Downloading charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (34 kB)
Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx)
  Downloading idna-3.10-py3-none-any.whl.metadata (10 kB)
Collecting urllib3<3,>=1.21.1 (from requests>=2.30.0->sphinx)
  Downloading urllib3-2.2.3-py3-none-any.whl.metadata (6.5 kB)
Collecting certifi>=2017.4.17 (from requests>=2.30.0->sphinx)
  Downloading certifi-2024.8.30-py3-none-any.whl.metadata (2.2 kB)
Downloading sphinx-8.1.3-py3-none-any.whl (3.5 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.5/3.5 MB 141.2 MB/s eta 0:00:00
Downloading alabaster-1.0.0-py3-none-any.whl (13 kB)
Downloading babel-2.16.0-py3-none-any.whl (9.6 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.6/9.6 MB 186.0 MB/s eta 0:00:00
Downloading docutils-0.21.2-py3-none-any.whl (587 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 363.6 MB/s eta 0:00:00
Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB)
Downloading jinja2-3.1.4-py3-none-any.whl (133 kB)
Downloading packaging-24.2-py3-none-any.whl (65 kB)
Downloading pygments-2.18.0-py3-none-any.whl (1.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 384.6 MB/s eta 0:00:00
Downloading requests-2.32.3-py3-none-any.whl (64 kB)
Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB)
Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl (119 kB)
Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl (82 kB)
Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl (98 kB)
Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl (88 kB)
Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl (92 kB)
Downloading certifi-2024.8.30-py3-none-any.whl (167 kB)
Downloading charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (142 kB)
Downloading idna-3.10-py3-none-any.whl (70 kB)
Downloading MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (23 kB)
Downloading urllib3-2.2.3-py3-none-any.whl (126 kB)
Installing collected packages: snowballstemmer, urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx
Successfully installed Jinja2-3.1.4 MarkupSafe-3.0.2 Pygments-2.18.0 alabaster-1.0.0 babel-2.16.0 certifi-2024.8.30 charset-normalizer-3.4.0 docutils-0.21.2 idna-3.10 imagesize-1.4.1 packaging-24.2 requests-2.32.3 snowballstemmer-2.2.0 sphinx-8.1.3 sphinxcontrib-applehelp-2.0.0 sphinxcontrib-devhelp-2.0.0 sphinxcontrib-htmlhelp-2.1.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-2.0.0 sphinxcontrib-serializinghtml-2.0.0 urllib3-2.2.3

[rtd-command-info] start-time: 2024-11-28T09:14:58.766124Z, end-time: 2024-11-28T09:15:01.461177Z, duration: 2, exit-code: 0
python -m pip install --exists-action=w --no-cache-dir -r requirements.txt
Collecting docutils<0.21 (from -r requirements.txt (line 1))
  Downloading docutils-0.20.1-py3-none-any.whl.metadata (2.8 kB)
Collecting recommonmark<0.7.1 (from -r requirements.txt (line 2))
  Downloading recommonmark-0.7.0-py2.py3-none-any.whl.metadata (463 bytes)
Collecting furo (from -r requirements.txt (line 3))
  Downloading furo-2024.8.6-py3-none-any.whl.metadata (5.9 kB)
Collecting myst_parser (from -r requirements.txt (line 4))
  Downloading myst_parser-4.0.0-py3-none-any.whl.metadata (5.4 kB)
Collecting sphinx_copybutton (from -r requirements.txt (line 5))
  Downloading sphinx_copybutton-0.5.2-py3-none-any.whl.metadata (3.2 kB)
Collecting sphinx_design (from -r requirements.txt (line 6))
  Downloading sphinx_design-0.6.1-py3-none-any.whl.metadata (5.5 kB)
Collecting sphinx_inline_tabs (from -r requirements.txt (line 7))
  Downloading sphinx_inline_tabs-2023.4.21-py3-none-any.whl.metadata (1.8 kB)
Collecting commonmark>=0.8.1 (from recommonmark<0.7.1->-r requirements.txt (line 2))
  Downloading commonmark-0.9.1-py2.py3-none-any.whl.metadata (5.7 kB)
Requirement already satisfied: sphinx>=1.3.1 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from recommonmark<0.7.1->-r requirements.txt (line 2)) (8.1.3)
Collecting beautifulsoup4 (from furo->-r requirements.txt (line 3))
  Downloading beautifulsoup4-4.12.3-py3-none-any.whl.metadata (3.8 kB)
Collecting sphinx-basic-ng>=1.0.0.beta2 (from furo->-r requirements.txt (line 3))
  Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl.metadata (1.5 kB)
Requirement already satisfied: pygments>=2.7 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from furo->-r requirements.txt (line 3)) (2.18.0)
Requirement already satisfied: jinja2 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from myst_parser->-r requirements.txt (line 4)) (3.1.4)
Collecting markdown-it-py~=3.0 (from myst_parser->-r requirements.txt (line 4))
  Downloading markdown_it_py-3.0.0-py3-none-any.whl.metadata (6.9 kB)
Collecting mdit-py-plugins>=0.4.1,~=0.4 (from myst_parser->-r requirements.txt (line 4))
  Downloading mdit_py_plugins-0.4.2-py3-none-any.whl.metadata (2.8 kB)
Collecting pyyaml (from myst_parser->-r requirements.txt (line 4))
  Downloading PyYAML-6.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (2.1 kB)
Collecting mdurl~=0.1 (from markdown-it-py~=3.0->myst_parser->-r requirements.txt (line 4))
  Downloading mdurl-0.1.2-py3-none-any.whl.metadata (1.6 kB)
Requirement already satisfied: sphinxcontrib-applehelp>=1.0.7 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (2.0.0)
Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (2.0.0)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (2.1.0)
Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (1.0.1)
Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (2.0.0)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (2.0.0)
Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (2.2.0)
Requirement already satisfied: babel>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (2.16.0)
Requirement already satisfied: alabaster>=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (1.0.0)
Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (1.4.1)
Requirement already satisfied: requests>=2.30.0 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (2.32.3)
Requirement already satisfied: packaging>=23.0 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (24.2)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from jinja2->myst_parser->-r requirements.txt (line 4)) (3.0.2)
Collecting soupsieve>1.2 (from beautifulsoup4->furo->-r requirements.txt (line 3))
  Downloading soupsieve-2.6-py3-none-any.whl.metadata (4.6 kB)
Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from requests>=2.30.0->sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (3.4.0)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from requests>=2.30.0->sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (3.10)
Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from requests>=2.30.0->sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (2.2.3)
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/metalsoft-metalsoft-docs/envs/latest/lib/python3.11/site-packages (from requests>=2.30.0->sphinx>=1.3.1->recommonmark<0.7.1->-r requirements.txt (line 2)) (2024.8.30)
Downloading docutils-0.20.1-py3-none-any.whl (572 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 44.2 MB/s eta 0:00:00
Downloading recommonmark-0.7.0-py2.py3-none-any.whl (10 kB)
Downloading furo-2024.8.6-py3-none-any.whl (341 kB)
Downloading myst_parser-4.0.0-py3-none-any.whl (84 kB)
Downloading sphinx_copybutton-0.5.2-py3-none-any.whl (13 kB)
Downloading sphinx_design-0.6.1-py3-none-any.whl (2.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 154.0 MB/s eta 0:00:00
Downloading sphinx_inline_tabs-2023.4.21-py3-none-any.whl (6.8 kB)
Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB)
Downloading markdown_it_py-3.0.0-py3-none-any.whl (87 kB)
Downloading mdit_py_plugins-0.4.2-py3-none-any.whl (55 kB)
Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl (22 kB)
Downloading beautifulsoup4-4.12.3-py3-none-any.whl (147 kB)
Downloading PyYAML-6.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (762 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 763.0/763.0 kB 484.7 MB/s eta 0:00:00
Downloading mdurl-0.1.2-py3-none-any.whl (10.0 kB)
Downloading soupsieve-2.6-py3-none-any.whl (36 kB)
Installing collected packages: commonmark, soupsieve, pyyaml, mdurl, docutils, markdown-it-py, beautifulsoup4, sphinx_inline_tabs, sphinx_design, sphinx_copybutton, sphinx-basic-ng, recommonmark, mdit-py-plugins, myst_parser, furo
  Attempting uninstall: docutils
    Found existing installation: docutils 0.21.2
    Uninstalling docutils-0.21.2:
      Successfully uninstalled docutils-0.21.2
Successfully installed beautifulsoup4-4.12.3 commonmark-0.9.1 docutils-0.20.1 furo-2024.8.6 markdown-it-py-3.0.0 mdit-py-plugins-0.4.2 mdurl-0.1.2 myst_parser-4.0.0 pyyaml-6.0.2 recommonmark-0.7.0 soupsieve-2.6 sphinx-basic-ng-1.0.0b2 sphinx_copybutton-0.5.2 sphinx_design-0.6.1 sphinx_inline_tabs-2023.4.21

[rtd-command-info] start-time: 2024-11-28T09:15:01.680196Z, end-time: 2024-11-28T09:15:01.739961Z, duration: 0, exit-code: 0
cat conf.py
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- 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 = u'MetalSoft'
copyright = u'2023, MetalSoft'
author = u'Alex Bordei'

# The short X.Y version
version = u''
# The full version, including alpha/beta/rc tags
release = u'v6.x'


# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# 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.imgmath',
    "sphinx.ext.autodoc",
    "sphinx.ext.intersphinx",
    "sphinx.ext.mathjax",
    "sphinx.ext.todo",
    "sphinx.ext.viewcode",
    #3rd party extensions
    "myst_parser",
    "sphinx_copybutton",
    "sphinx_design",
    "sphinx_inline_tabs",
]

extlinks = {
    "pypi": ("https://pypi.org/project/%s/", "%s"),
}

intersphinx_mapping = {
    "python": ("https://docs.python.org/3", None),
    "sphinx": ("https://www.sphinx-doc.org/en/master", None),
}

myst_enable_extensions = [
    "colon_fence",
    "deflist",
    "attrs_inline",
]
myst_heading_anchors = 3

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
#source_suffix = ['.rst', '.md', '.txt']


# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"

# 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 = [u'_build', 'Thumbs.db', '.DS_Store','scripts',"README.md","requirements.txt","userindex.md"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None

html_extra_path = ["others"]

# -- 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_rtd_theme"
html_theme = "furo"
#html_theme = "ext-theme"
#html_theme = "default"
# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#

#html_theme_options = {
#    'collapse_navigation': False,
#    'display_version': False,
#    'navigation_depth': 3,
#}

html_theme_options = {
    "light_logo": "logo.svg",
     "dark_logo": "logo-white.svg",
     "sidebar_hide_name": True,
     "light_css_variables": {
        "color-brand-primary": "#0539C1",
    },
    "source_directory": "/",

}

html_title="MetalSoft 6.x Documentation"

# 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']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'metalsoftdoc'


# -- Options for LaTeX output ------------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'metalsoft.tex', u'metalsoft Documentation',
     u'Alex Bordei', 'manual'),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'metalsoft', u'Metalsoft Documentation',
     [author], 1)
]


# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'metalsoft', u'Metalsoft Documentation',
     author, 'metalsoft', 'One line description of project.',
     'Miscellaneous'),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']


# -- Extension configuration -------------------------------------------------