Agregar documentación con Sphinx

Signed-off-by: Edgar Alvarado Taleno <edgar.alvaradotaleno@ucr.ac.cr>
This commit is contained in:
Edgar Alvarado Taleno 2025-04-10 21:03:03 -06:00
parent 176b4fa719
commit b3ae3117f9
159 changed files with 12034 additions and 13008 deletions

View file

@ -5,11 +5,10 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
import os
import sys
sys.path.insert(0, os.path.abspath('../../src'))
sys.path.insert(0, os.path.abspath('../../src'))
project = 'Flask'
copyright = '2025, Pallets Team'
author = 'Pallets Team'
@ -18,9 +17,9 @@ author = 'Pallets Team'
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.autodoc', # Para generar doc automáticamente desde los docstrings
'sphinx.ext.napoleon', # Para soportar docstrings estilo Google/NumPy
'sphinx.ext.todo', # Para mostrar TODOs
'sphinx.ext.autodoc',
'sphinx.ext.napoleon', # Para Google/NumPy docstrings
'sphinx.ext.todo',
]
templates_path = ['_templates']
@ -33,5 +32,3 @@ exclude_patterns = []
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
todo_include_todos = True

View file

@ -1,13 +1,16 @@
.. Flask documentation master file, created by
sphinx-quickstart on Thu Apr 10 15:29:04 2025.
sphinx-quickstart on Thu Apr 10 19:53:46 2025.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Flask documentation
===================
Flask - Documentación Personalizada
====================================
Bienvenido a la documentación del proyecto Flask.
.. toctree::
:maxdepth: 2
:caption: Contents:
:caption: Contenido:
modules