Versão de documentação mais personalizável
This commit is contained in:
parent
5aa14612df
commit
0a67bb9bdb
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"recommendations": [
|
||||
"tamasfe.even-better-toml",
|
||||
"vscode-icons-team.vscode-icons",
|
||||
"yzhang.markdown-all-in-one",
|
||||
"ms-ceintl.vscode-language-pack-pt-br"
|
||||
]
|
||||
}
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
# Aula de 13/03/2026
|
||||
|
||||
Apresentação
|
||||
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
# Apresentação de Levi Neves
|
||||
|
||||
## Quem sou eu
|
||||
|
||||
ugodifgpiai
|
||||
|
||||
## o que gosto de fazer
|
||||
|
||||
lhsfiouhpaiof
|
||||
|
||||
## o que sei fazer bem
|
||||
|
||||
oihfiouas
|
||||
31
docs/conf.py
31
docs/conf.py
|
|
@ -6,10 +6,21 @@
|
|||
# -- Project information -----------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||
|
||||
project = 'DOCE'
|
||||
copyright = '2026, AUTOR'
|
||||
author = 'AUTOR'
|
||||
release = 'ANO_PERIODO'
|
||||
# Doce ambiente
|
||||
|
||||
DISC = 'DISC' # Sigla, acrônimo ou abreviação para disciplina
|
||||
AUTOR = '{Nome} {Sobrenome}' # Nome e um sobrenome, com iniciais maiúsculas
|
||||
ANO = '2026' # Ano da disciplina
|
||||
PERIODO = '1' # Período da disciplina
|
||||
NAMESPACE = 'redes20261' # Espaço nominal do repositório remoto do Git
|
||||
REPO = 'isa-2026-1' # Nome do repositório remoto
|
||||
|
||||
## As próximas configurações são do Sphinx
|
||||
|
||||
project = f'DOCE {DISC}'
|
||||
copyright = f'{ANO}, {AUTOR}'
|
||||
author = f'{AUTOR}'
|
||||
release = f'{ANO}_{PERIODO}'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
|
@ -28,31 +39,29 @@ language = 'pt_BR'
|
|||
# -- Options for HTML output -------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||
|
||||
namespace = 'redes20261'
|
||||
repo = 'isa-2026-1'
|
||||
|
||||
html_theme = 'furo'
|
||||
html_title = html_short_title = project
|
||||
html_static_path = ['_static']
|
||||
html_theme_options = {
|
||||
"source_repository": f"https://gitea.mange.ifrn.edu.br/{namespace}/{repo}/",
|
||||
"source_repository": f"https://gitea.mange.ifrn.edu.br/{NAMESPACE}/{REPO}/",
|
||||
"source_branch": "main",
|
||||
"source_directory": "docs/",
|
||||
"source_edit_link": f"https://gitea.mange.ifrn.edu.br/{namespace}/{repo}/_edit/main/docs/{{filename}}",
|
||||
"source_view_link": f"https://gitea.mange.ifrn.edu.br/{namespace}/{repo}/src/branch/main/docs/{{filename}}",
|
||||
"source_edit_link": f"https://gitea.mange.ifrn.edu.br/{NAMESPACE}/{REPO}/_edit/main/docs/{{filename}}",
|
||||
"source_view_link": f"https://gitea.mange.ifrn.edu.br/{NAMESPACE}/{REPO}/src/branch/main/docs/{{filename}}",
|
||||
}
|
||||
|
||||
myst_links_external_new_tab = True
|
||||
myst_number_code_blocks = ['Python', 'Bash']
|
||||
myst_heading_anchors = 3
|
||||
myst_enable_extensions = {
|
||||
#"colon_fence": True,
|
||||
"colon_fence": True,
|
||||
# "dolarmath": True,
|
||||
# "deflist": True,
|
||||
# "linkify": True,
|
||||
# "replacements": True,
|
||||
# "strikethrough": True,
|
||||
# "tasklist": True,
|
||||
"tasklist": True,
|
||||
}
|
||||
|
||||
bibtex_bibfiles = ['refs.bib']
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
[project]
|
||||
name = "doce"
|
||||
version = "0.1.0"
|
||||
description = "Add your description here"
|
||||
description = "Documentação Estudantil"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.14"
|
||||
dependencies = [
|
||||
"furo>=2025.12.19",
|
||||
"myst-parser>=5.0.0",
|
||||
"python-dotenv>=1.2.2",
|
||||
"sphinx>=9.1.0",
|
||||
"sphinx-autobuild>=2025.8.25",
|
||||
"sphinxcontrib-bibtex>=2.6.5",
|
||||
|
|
|
|||
11
uv.lock
11
uv.lock
|
|
@ -119,6 +119,7 @@ source = { virtual = "." }
|
|||
dependencies = [
|
||||
{ name = "furo" },
|
||||
{ name = "myst-parser" },
|
||||
{ name = "python-dotenv" },
|
||||
{ name = "sphinx" },
|
||||
{ name = "sphinx-autobuild" },
|
||||
{ name = "sphinxcontrib-bibtex" },
|
||||
|
|
@ -129,6 +130,7 @@ dependencies = [
|
|||
requires-dist = [
|
||||
{ name = "furo", specifier = ">=2025.12.19" },
|
||||
{ name = "myst-parser", specifier = ">=5.0.0" },
|
||||
{ name = "python-dotenv", specifier = ">=1.2.2" },
|
||||
{ name = "sphinx", specifier = ">=9.1.0" },
|
||||
{ name = "sphinx-autobuild", specifier = ">=2025.8.25" },
|
||||
{ name = "sphinxcontrib-bibtex", specifier = ">=2.6.5" },
|
||||
|
|
@ -332,6 +334,15 @@ wheels = [
|
|||
{ url = "https://files.pythonhosted.org/packages/c7/21/705964c7812476f378728bdf590ca4b771ec72385c533964653c68e86bdc/pygments-2.19.2-py3-none-any.whl", hash = "sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b", size = 1225217, upload-time = "2025-06-21T13:39:07.939Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "python-dotenv"
|
||||
version = "1.2.2"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/82/ed/0301aeeac3e5353ef3d94b6ec08bbcabd04a72018415dcb29e588514bba8/python_dotenv-1.2.2.tar.gz", hash = "sha256:2c371a91fbd7ba082c2c1dc1f8bf89ca22564a087c2c287cd9b662adde799cf3", size = 50135, upload-time = "2026-03-01T16:00:26.196Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/0b/d7/1959b9648791274998a9c3526f6d0ec8fd2233e4d4acce81bbae76b44b2a/python_dotenv-1.2.2-py3-none-any.whl", hash = "sha256:1d8214789a24de455a8b8bd8ae6fe3c6b69a5e3d64aa8a8e5d68e694bbcb285a", size = 22101, upload-time = "2026-03-01T16:00:25.09Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pyyaml"
|
||||
version = "6.0.3"
|
||||
|
|
|
|||
Loading…
Reference in New Issue