Preparar para publicar en Read the Docs

Signed-off-by: Edgar Alvarado Taleno <edgar.alvaradotaleno@ucr.ac.cr>
This commit is contained in:
Edgar Alvarado Taleno 2025-04-10 15:52:02 -06:00
parent b78b5a210b
commit 77f3f78332
190 changed files with 48425 additions and 102 deletions

37
docs/source/conf.py Normal file
View file

@ -0,0 +1,37 @@
# 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
import os
import sys
sys.path.insert(0, os.path.abspath('../../src'))
project = 'Flask'
copyright = '2025, Pallets Team'
author = 'Pallets Team'
# -- General configuration ---------------------------------------------------
# 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
]
templates_path = ['_templates']
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
todo_include_todos = True

View file

@ -0,0 +1,29 @@
flask.json package
==================
Submodules
----------
flask.json.provider module
--------------------------
.. automodule:: flask.json.provider
:members:
:undoc-members:
:show-inheritance:
flask.json.tag module
---------------------
.. automodule:: flask.json.tag
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: flask.json
:members:
:undoc-members:
:show-inheritance:

149
docs/source/flask.rst Normal file
View file

@ -0,0 +1,149 @@
flask package
=============
Subpackages
-----------
.. toctree::
:maxdepth: 4
flask.json
Submodules
----------
flask.app module
----------------
.. automodule:: flask.app
:members:
:undoc-members:
:show-inheritance:
flask.blueprints module
-----------------------
.. automodule:: flask.blueprints
:members:
:undoc-members:
:show-inheritance:
flask.cli module
----------------
.. automodule:: flask.cli
:members:
:undoc-members:
:show-inheritance:
flask.config module
-------------------
.. automodule:: flask.config
:members:
:undoc-members:
:show-inheritance:
flask.ctx module
----------------
.. automodule:: flask.ctx
:members:
:undoc-members:
:show-inheritance:
flask.debughelpers module
-------------------------
.. automodule:: flask.debughelpers
:members:
:undoc-members:
:show-inheritance:
flask.globals module
--------------------
.. automodule:: flask.globals
:members:
:undoc-members:
:show-inheritance:
flask.helpers module
--------------------
.. automodule:: flask.helpers
:members:
:undoc-members:
:show-inheritance:
flask.logging module
--------------------
.. automodule:: flask.logging
:members:
:undoc-members:
:show-inheritance:
flask.sessions module
---------------------
.. automodule:: flask.sessions
:members:
:undoc-members:
:show-inheritance:
flask.signals module
--------------------
.. automodule:: flask.signals
:members:
:undoc-members:
:show-inheritance:
flask.templating module
-----------------------
.. automodule:: flask.templating
:members:
:undoc-members:
:show-inheritance:
flask.testing module
--------------------
.. automodule:: flask.testing
:members:
:undoc-members:
:show-inheritance:
flask.typing module
-------------------
.. automodule:: flask.typing
:members:
:undoc-members:
:show-inheritance:
flask.views module
------------------
.. automodule:: flask.views
:members:
:undoc-members:
:show-inheritance:
flask.wrappers module
---------------------
.. automodule:: flask.wrappers
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: flask
:members:
:undoc-members:
:show-inheritance:

13
docs/source/index.rst Normal file
View file

@ -0,0 +1,13 @@
.. Flask documentation master file, created by
sphinx-quickstart on Thu Apr 10 15:29:04 2025.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Flask documentation
===================
.. toctree::
:maxdepth: 2
:caption: Contents:
modules

7
docs/source/modules.rst Normal file
View file

@ -0,0 +1,7 @@
flask
=====
.. toctree::
:maxdepth: 4
flask