feat(Bamemetals): add recover system doc

.pre-commit-config.yaml

+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      - id: check-symlinks
+      - id: detect-private-key
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v2.37.0
+    hooks:
+      - id: commitizen
+      - id: commitizen-branch
+        stages: [push]
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+#  - repo: local
+#    hooks:
+#      - id: pipenv-generetate-requirements
+#        name: Generate requirements.txt
+#        description: This hook generate the requirements.txt based on pipfile
+#        entry: scripts/generate-requeriments.sh
+#        language: script
+#        files: ^Pipfile(\.lock)?$
+#        stages: [merge-commit, push, prepare-commit-msg]

.readthedocs.yaml

+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+python:
+  install:
+    - requirements: ./requirements.txt
+sphinx:
+  configuration: source/conf.py
+formats:
+  - pdf
+  - epub

CHANGELOG.md

+## 0.2.0 (2022-12-07)
+
+### Feat
+
+- **Conf**: update conf
+
+### Fix
+
+- fix requeriments
+
+## 0.1.0 (2022-11-03)
+
+### Feat
+
+- **build**: add .gitkeep on empty directories

LICENSE

+MIT License
+
+Copyright (c) 2022 C3SL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Pipfile

+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+sphinx = "*"
+sphinx-rtd-theme = "*"
+commitizen = "*"
+pre-commit = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.10"

README.md

+# Template Read the docs
+Este repositório server de template para documentação do readthedocs do C3SL
+[docs](docs.c3sl.ufpr.br).
+
+[[_TOC_]]
+
+# Como começar
+O primeiro passo é realizar o folk do template e depois clonar o folk.
+
+Após clonar, edite a documentação localizada em `sources` e quando terminar faça push para o gitlab
+e link no [docs](docs.c3sl.ufpr.br).
+
+
+# Organização do repositório
+O repositório é dedicado a documentação e esta orgazanizado da seguinte maneira:
+  * `build/` Diretório onde os arquivos compilados vão.
+  * `cz.yaml` Arquivo de configuração do commitizen
+  * `.git` Diretório de configuração do git
+  * `.gitignore`Arquivo com padrões de nomes que o git deve ignorar ao realizar `git add` ou `git
+  stage`
+  * `Makefile` Makefile para fazer o build da documentação, resultado vai para o diretório `build`
+  * `Pipfile` Arquivo do pipenv para criar ambiente do python para fazer build
+  * `Pipfile.lock` Arquivo do pipenv para criar ambiente do python para fazer build
+  * `.pre-commit-config.yaml` Arquivo de configuração do pre-commit
+  * `README.md` arquivo de readme do repositório.
+  * `.readthedocs.yaml` Arquivo de configuração do readthedocs
+  * `requirements.txt` Arquivos com listas de modulos python para fazer build da documentação, deve
+  ser igual ao `Pipfile`
+  * `LICENSE` arquivo de licença
+  * `.gitlab-ci.yml` Arquivo do Gitlab CI
+  * `scripts/` Diretório com scripts variados.
+    * `generate-requeriments.sh` Script que gera o arquivo `requirements.txt` a partir do `Pipfile`.
+  * `source/` Diretório da documentação.
+    * `conf.py` Arquivo de configuração do sphinx
+    * `index.rst` Primeira página da documentação
+    * `pages/` Diretório  com as páginas da documentação
+      * `quickstart-rst.rst` Página com dicas de rst com sphinx
+      * `quickstart-conf.rst` Página com dicas de configuração do `conf.py`
+      * `quickstart-rdt.rst` Página de como incluir um repositório em [docs](docs.c3sl.ufpr.br)
+    * `_static/` Diretório para armazenar arquivos estáticos, como imagens, gifs e etc.
+    * `_templates/` Diretório para armazenar estilização das páginas, css, html e etc.

README.rst

-Template for the Read the Docs tutorial
-=======================================
-
-This GitHub template includes fictional Python library
-with some basic Sphinx docs.
-
-Read the tutorial here:
-
-https://docs.readthedocs.io/en/stable/tutorial/

cz.yaml

+commitizen:
+  name: cz_conventional_commits
+  tag_format: $version
+  version: 0.1.0

docs/make.bat

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

docs/source/api.rst

-API
-===
-
-.. autosummary::
-   :toctree: generated
-
-   lumache

docs/source/conf.py

-# Configuration file for the Sphinx documentation builder.
-
-# -- Project information
-
-project = 'Lumache'
-copyright = '2021, Graziella'
-author = 'Graziella'
-
-release = '0.1'
-version = '0.1.0'
-
-# -- General configuration
-
-extensions = [
-    'sphinx.ext.duration',
-    'sphinx.ext.doctest',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
-]
-
-intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
-}
-intersphinx_disabled_domains = ['std']
-
-templates_path = ['_templates']
-
-# -- Options for HTML output
-
-html_theme = 'sphinx_rtd_theme'
-
-# -- Options for EPUB output
-epub_show_urls = 'footnote'

docs/source/index.rst

-Welcome to Lumache's documentation!
-===================================
-
-**Lumache** (/lu'make/) is a Python library for cooks and food lovers
-that creates recipes mixing random ingredients.
-It pulls data from the `Open Food Facts database <https://world.openfoodfacts.org/>`_
-and offers a *simple* and *intuitive* API.
-
-Check out the :doc:`usage` section for further information, including
-how to :ref:`installation` the project.
-
-.. note::
-
-   This project is under active development.
-
-Contents
---------
-
-.. toctree::
-
-   usage
-   api

docs/source/usage.rst

-Usage
-=====
-
-.. _installation:
-
-Installation
-------------
-
-To use Lumache, first install it using pip:
-
-.. code-block:: console
-
-   (.venv) $ pip install lumache
-
-Creating recipes
-----------------
-
-To retrieve a list of random ingredients,
-you can use the ``lumache.get_random_ingredients()`` function:
-
-.. autofunction:: lumache.get_random_ingredients
-
-The ``kind`` parameter should be either ``"meat"``, ``"fish"``,
-or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
-will raise an exception.
-
-.. autoexception:: lumache.InvalidKindError
-
-For example:
-
->>> import lumache
->>> lumache.get_random_ingredients()
-['shells', 'gorgonzola', 'parsley']
-

lumache.py

-"""
-Lumache - Python library for cooks and food lovers.
-"""
-
-__version__ = "0.1.0"
-
-
-class InvalidKindError(Exception):
-    """Raised if the kind is invalid."""
-    pass
-
-
-def get_random_ingredients(kind=None):
-    """
-    Return a list of random ingredients as strings.
-
-    :param kind: Optional "kind" of ingredients.
-    :type kind: list[str] or None
-    :raise lumache.InvalidKindError: If the kind is invalid.
-    :return: The ingredients list.
-    :rtype: list[str]
-    """
-    return ["shells", "gorgonzola", "parsley"]

pyproject.toml

-[build-system]
-requires = ["flit_core >=3.2,<4"]
-build-backend = "flit_core.buildapi"
-
-[project]
-name = "lumache"
-authors = [{name = "Graziella", email = "graziella@lumache"}]
-dynamic = ["version", "description"]

requirements.txt

+#
+# These requirements were autogenerated by pipenv
+# To regenerate from the project's Pipfile, run:
+#
+#    pipenv lock --requirements
+#
+
+-i https://pypi.org/simple
+alabaster==0.7.12
+babel==2.10.3; python_version >= '3.6'
+certifi==2022.6.15; python_version >= '3.6'
+charset-normalizer==2.1.1; python_version >= '3.6'
+docutils==0.17.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+idna==3.3; python_version >= '3.5'
+imagesize==1.4.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+importlib-metadata==4.12.0
+jinja2==3.1.2; python_version >= '3.7'
+markupsafe==2.1.1; python_version >= '3.7'
+packaging==21.3; python_version >= '3.6'
+pygments==2.13.0; python_version >= '3.6'
+pyparsing==3.0.9; python_full_version >= '3.6.8'
+pytz==2022.2.1
+requests==2.28.1; python_version >= '3.7' and python_version < '4'
+snowballstemmer==2.2.0
+sphinx-rtd-size==0.2.0
+sphinx-rtd-theme==1.0.0
+sphinx==5.1.1
+sphinxcontrib-applehelp==1.0.2; python_version >= '3.5'
+sphinxcontrib-devhelp==1.0.2; python_version >= '3.5'
+sphinxcontrib-htmlhelp==2.0.0; python_version >= '3.6'
+sphinxcontrib-jsmath==1.0.1; python_version >= '3.5'
+sphinxcontrib-qthelp==1.0.3; python_version >= '3.5'
+sphinxcontrib-serializinghtml==1.1.5; python_version >= '3.5'
+urllib3==1.26.12; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5' and python_version < '4'
+zipp==3.8.1; python_version >= '3.7'

scripts/generate-requeriments.sh

+#!/usr/bin/sh
+pipenv lock -r > requirements.txt