Versão de documentação mais personalizável
This commit is contained in:
+20
-11
@@ -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']
|
||||
|
||||
Reference in New Issue
Block a user