Skip to content

Commit f5efe44

Browse files
LouisTierLouisTier
committed
Add GH actions and docs.
1 parent 0e80ae1 commit f5efe44

File tree

6 files changed

+177
-0
lines changed

6 files changed

+177
-0
lines changed

‎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/conf.py‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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 = "TorchSOM"
10+
copyright = "2025, Manufacture Française des Pneumatiques Michelin"
11+
author = "Louis Berthier"
12+
release = "0.0.1"
13+
14+
# -- General configuration ---------------------------------------------------
15+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16+
17+
extensions = [
18+
"sphinx.ext.duration",
19+
"sphinx.ext.doctest",
20+
"sphinx.ext.autodoc",
21+
"sphinx.ext.autosummary",
22+
"sphinx.ext.intersphinx",
23+
]
24+
25+
templates_path = ["_templates"]
26+
exclude_patterns = []
27+
28+
29+
# -- Options for HTML output -------------------------------------------------
30+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
31+
32+
html_theme = "alabaster" # "sphinx_rtd_theme"
33+
html_logo = "../../logo.jpg"
34+
html_static_path = ["_static"]

‎docs/source/index.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. TorchSOM documentation master file, created by
2+
sphinx-quickstart on Tue May 6 18:37:48 2025.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
TorchSOM 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: API Reference
17+
18+
modules
19+
.. :caption: Contents:
20+

‎docs/source/modules.rst‎

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

‎docs/source/torchsom.rst‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
torchsom package
2+
================
3+
4+
Submodules
5+
----------
6+
7+
torchsom.core module
8+
--------------------
9+
10+
.. automodule:: torchsom.core
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
torchsom.decay module
16+
---------------------
17+
18+
.. automodule:: torchsom.decay
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
torchsom.distances module
24+
-------------------------
25+
26+
.. automodule:: torchsom.distances
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
torchsom.neighborhood module
32+
----------------------------
33+
34+
.. automodule:: torchsom.neighborhood
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:
38+
39+
torchsom.plotting module
40+
------------------------
41+
42+
.. automodule:: torchsom.plotting
43+
:members:
44+
:show-inheritance:
45+
:undoc-members:
46+
47+
torchsom.utils module
48+
---------------------
49+
50+
.. automodule:: torchsom.utils
51+
:members:
52+
:show-inheritance:
53+
:undoc-members:
54+
55+
Module contents
56+
---------------
57+
58+
.. automodule:: torchsom
59+
:members:
60+
:show-inheritance:
61+
:undoc-members:

0 commit comments

Comments
 (0)