Skip to content

Commit 07de5f0

Browse files
committed
Se ha generado docs correctamente usando sphinx. Se actualizó requirements.txt.
1 parent 1e1c6b7 commit 07de5f0

9 files changed

Lines changed: 186 additions & 1 deletion

File tree

docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/bhexpress.api_client.bhe.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
bhexpress.api\_client.bhe package
2+
=================================
3+
4+
Submodules
5+
----------
6+
7+
bhexpress.api\_client.bhe.boletas module
8+
----------------------------------------
9+
10+
.. automodule:: bhexpress.api_client.bhe.boletas
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: bhexpress.api_client.bhe
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

docs/bhexpress.api_client.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
bhexpress.api\_client package
2+
=============================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
bhexpress.api_client.bhe
11+
12+
Module contents
13+
---------------
14+
15+
.. automodule:: bhexpress.api_client
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:

docs/bhexpress.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
bhexpress package
2+
=================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
bhexpress.api_client
11+
12+
Module contents
13+
---------------
14+
15+
.. automodule:: bhexpress
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:

docs/conf.py

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'bhexpress'
10+
copyright = '2024, bhexpress'
11+
author = 'bhexpress'
12+
release = '1.0.1'
13+
14+
# -- General configuration ---------------------------------------------------
15+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16+
17+
extensions = []
18+
19+
templates_path = ['_templates']
20+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
21+
22+
language = 'es'
23+
24+
# -- Options for HTML output -------------------------------------------------
25+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
26+
27+
html_theme = 'alabaster'
28+
html_static_path = ['_static']

docs/index.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. bhexpress documentation master file, created by
2+
sphinx-quickstart on Fri Jul 19 12:31:01 2024.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
bhexpress documentation
7+
=======================
8+
9+
Add your content using ``reStructuredText`` syntax. See the
10+
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11+
documentation for details.
12+
13+
14+
.. toctree::
15+
:maxdepth: 2
16+
:caption: Contents:
17+

docs/make.bat

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

docs/modules.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
api_client
2+
==========
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
api_client

requirements.txt

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
1+
alabaster==0.7.16
2+
Babel==2.15.0
3+
certifi==2024.7.4
4+
charset-normalizer==3.3.2
5+
colorama==0.4.6
6+
docutils==0.21.2
7+
idna==3.7
8+
imagesize==1.4.1
9+
Jinja2==3.1.4
10+
MarkupSafe==2.1.5
11+
packaging==24.1
12+
Pygments==2.18.0
113
python-dotenv==1.0.1
2-
requests==2.32.3
14+
requests==2.32.3
15+
snowballstemmer==2.2.0
16+
Sphinx==7.4.6
17+
sphinxcontrib-applehelp==1.0.8
18+
sphinxcontrib-devhelp==1.0.6
19+
sphinxcontrib-htmlhelp==2.0.5
20+
sphinxcontrib-jsmath==1.0.1
21+
sphinxcontrib-qthelp==1.0.7
22+
sphinxcontrib-serializinghtml==1.1.10
23+
urllib3==2.2.2

0 commit comments

Comments
 (0)