Initial commit

.gitignore

+
+# Created by https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,jupyternotebooks
+
+### JupyterNotebooks ###
+# gitignore template for Jupyter Notebooks
+# website: http://jupyter.org/
+
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Remove previous ipynb_checkpoints
+#   git rm -r .ipynb_checkpoints/
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+
+# IPython
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks

.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

Makefile

+# 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)

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.

cz.yaml

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

requirements.txt

+sphinx
+sphinx-rtd-theme
+commitizen
+pre-commit

scripts/generate-requeriments.sh

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

source/conf.py

+# 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 = "Template-RDT"
+copyright = "2022, Odair M."
+author = "Odair M."
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+language = "pt"
+
+# -- 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"]

source/index.rst

+.. Template-RDT documentation master file, created by
+   sphinx-quickstart on Wed Nov  2 22:52:13 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Template-RDT's documentation!
+========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`