Skip to content

Commit b79316e

Browse files
tausiajtausiaj
committed
[JTH] add docs first version to test deploy
1 parent 010f992 commit b79316e

31 files changed

+1015
-0
lines changed

‎.github/workflows/build-docs.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Build and Deploy Documentation
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*"
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
docs:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v4
17+
18+
- uses: actions/setup-python@v5
19+
20+
- name: Install dependencies
21+
run: |
22+
pip install sphinx sphinx-rtd-theme jupyter-sphinx
23+
24+
- name: Sphinx build
25+
run: |
26+
sphinx-apidoc -o docs/source/ bluemath_tk/
27+
sphinx-build docs/source/ docs/build/
28+
29+
- name: Deploy to GitHub Pages
30+
uses: peaceiris/actions-gh-pages@v3
31+
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
32+
with:
33+
publish_branch: gh-pages
34+
github_token: ${{ secrets.GITHUB_TOKEN }}
35+
publish_dir: docs/build/
36+
force_orphan: true

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ instance/
7575
# Sphinx documentation
7676
docs/_build/
7777
docs/logs/
78+
docs/jupyter_execute/
7879
docs/*.pkl
7980

8081
# MkDocs documentation (production)

‎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 = source
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/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=source
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/source/bluemath_tk.core.data.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
bluemath\_tk.core.data package
2+
==============================
3+
4+
Submodules
5+
----------
6+
7+
bluemath\_tk.core.data.sample\_data module
8+
------------------------------------------
9+
10+
.. automodule:: bluemath_tk.core.data.sample_data
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: bluemath_tk.core.data
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/bluemath_tk.core.plotting.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
bluemath\_tk.core.plotting package
2+
==================================
3+
4+
Submodules
5+
----------
6+
7+
bluemath\_tk.core.plotting.base\_plotting module
8+
------------------------------------------------
9+
10+
.. automodule:: bluemath_tk.core.plotting.base_plotting
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
bluemath\_tk.core.plotting.colors module
16+
----------------------------------------
17+
18+
.. automodule:: bluemath_tk.core.plotting.colors
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: bluemath_tk.core.plotting
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎docs/source/bluemath_tk.core.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
bluemath\_tk.core package
2+
=========================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
bluemath_tk.core.data
11+
bluemath_tk.core.plotting
12+
13+
Submodules
14+
----------
15+
16+
bluemath\_tk.core.decorators module
17+
-----------------------------------
18+
19+
.. automodule:: bluemath_tk.core.decorators
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
bluemath\_tk.core.logging module
25+
--------------------------------
26+
27+
.. automodule:: bluemath_tk.core.logging
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
bluemath\_tk.core.models module
33+
-------------------------------
34+
35+
.. automodule:: bluemath_tk.core.models
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
40+
bluemath\_tk.core.operations module
41+
-----------------------------------
42+
43+
.. automodule:: bluemath_tk.core.operations
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:
47+
48+
Module contents
49+
---------------
50+
51+
.. automodule:: bluemath_tk.core
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:

‎docs/source/bluemath_tk.datamining.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
bluemath\_tk.datamining package
2+
===============================
3+
4+
Submodules
5+
----------
6+
7+
bluemath\_tk.datamining.kma module
8+
----------------------------------
9+
10+
.. automodule:: bluemath_tk.datamining.kma
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
bluemath\_tk.datamining.lhs module
16+
----------------------------------
17+
18+
.. automodule:: bluemath_tk.datamining.lhs
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
bluemath\_tk.datamining.mda module
24+
----------------------------------
25+
26+
.. automodule:: bluemath_tk.datamining.mda
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
bluemath\_tk.datamining.pca module
32+
----------------------------------
33+
34+
.. automodule:: bluemath_tk.datamining.pca
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
bluemath\_tk.datamining.som module
40+
----------------------------------
41+
42+
.. automodule:: bluemath_tk.datamining.som
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Module contents
48+
---------------
49+
50+
.. automodule:: bluemath_tk.datamining
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:

‎docs/source/bluemath_tk.distributions.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
bluemath\_tk.distributions package
2+
==================================
3+
4+
Submodules
5+
----------
6+
7+
bluemath\_tk.distributions.copula module
8+
----------------------------------------
9+
10+
.. automodule:: bluemath_tk.distributions.copula
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
bluemath\_tk.distributions.gev module
16+
-------------------------------------
17+
18+
.. automodule:: bluemath_tk.distributions.gev
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
bluemath\_tk.distributions.gpd module
24+
-------------------------------------
25+
26+
.. automodule:: bluemath_tk.distributions.gpd
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
bluemath\_tk.distributions.poisson module
32+
-----------------------------------------
33+
34+
.. automodule:: bluemath_tk.distributions.poisson
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
bluemath\_tk.distributions.pot module
40+
-------------------------------------
41+
42+
.. automodule:: bluemath_tk.distributions.pot
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Module contents
48+
---------------
49+
50+
.. automodule:: bluemath_tk.distributions
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:

‎docs/source/bluemath_tk.downloaders.copernicus.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
bluemath\_tk.downloaders.copernicus package
2+
===========================================
3+
4+
Submodules
5+
----------
6+
7+
bluemath\_tk.downloaders.copernicus.copernicus\_downloader module
8+
-----------------------------------------------------------------
9+
10+
.. automodule:: bluemath_tk.downloaders.copernicus.copernicus_downloader
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: bluemath_tk.downloaders.copernicus
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

0 commit comments

Comments
 (0)