5505-public/dima
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Synch with remote repo

Browse Source
This commit is contained in:
florez_j
2025-02-03 10:31:48 +01:00
parent a3ccff4079
commit 32bba4239a
102 changed files with 19584 additions and 19584 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
docs/source/conf.py
View File

@ -1,55 +1,55 @@
# 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
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
print(os.getcwd())
#print(os.path.abspath('../..'))
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'DIMA'
copyright = '2024, JFFO'
author = 'JFFO'
release = '1.0.0'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'nbsphinx', # added for jupyter notebooks
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.viewcode', # This extension adds links to highlighted source code
]
templates_path = ['_templates']
exclude_patterns = []
# nbsphinx configuration options
nbsphinx_allow_errors = True # Continue through notebook execution errors
#nbsphinx_execute = 'always' # Execute notebooks before converting
nbsphinx_execute = 'never' # Execute notebooks before converting
# If you want to include the content of the Jupyter notebook cells in the index
nbsphinx_prolog = """
.. raw:: html
<div class="nbsphinx-separator"></div>
"""
# -- 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']
#extensions = [
# 'sphinx.ext.autodoc',
# 'sphinx.ext.napoleon',
# 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
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
print(os.getcwd())
#print(os.path.abspath('../..'))
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'DIMA'
copyright = '2024, JFFO'
author = 'JFFO'
release = '1.0.0'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'nbsphinx', # added for jupyter notebooks
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.viewcode', # This extension adds links to highlighted source code
]
templates_path = ['_templates']
exclude_patterns = []
# nbsphinx configuration options
nbsphinx_allow_errors = True # Continue through notebook execution errors
#nbsphinx_execute = 'always' # Execute notebooks before converting
nbsphinx_execute = 'never' # Execute notebooks before converting
# If you want to include the content of the Jupyter notebook cells in the index
nbsphinx_prolog = """
.. raw:: html
<div class="nbsphinx-separator"></div>
"""
# -- 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']
#extensions = [
# 'sphinx.ext.autodoc',
# 'sphinx.ext.napoleon',
#]

56
docs/source/index.rst
View File

@ -1,28 +1,28 @@
.. DIMA documentation master file, created by
sphinx-quickstart on Wed Jul 10 15:50:06 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to DIMA's documentation!
================================
.. toctree::
:maxdepth: 2
:caption: Contents:
modules/src
modules/pipelines
modules/vis
modules/utils
modules/notebooks
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. DIMA documentation master file, created by
sphinx-quickstart on Wed Jul 10 15:50:06 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to DIMA's documentation!
================================
.. toctree::
:maxdepth: 2
:caption: Contents:
modules/src
modules/pipelines
modules/vis
modules/utils
modules/notebooks
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

12
docs/source/modules/notebooks.rst
View File

@ -1,7 +1,7 @@
Notebooks
==========================
.. automodule:: notebooks
:members:
:undoc-members:
Notebooks
==========================
.. automodule:: notebooks
:members:
:undoc-members:
:show-inheritance:

22
docs/source/modules/pipelines.rst
View File

@ -1,12 +1,12 @@
Pipelines and workflows
==========================
.. automodule:: pipelines.data_integration
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pipelines.metadata_revision
:members:
:undoc-members:
Pipelines and workflows
==========================
.. automodule:: pipelines.data_integration
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pipelines.metadata_revision
:members:
:undoc-members:
:show-inheritance:

36
docs/source/modules/src.rst
View File

@ -1,18 +1,18 @@
HDF5 Data Operations
==========================
.. automodule:: src.hdf5_ops
:members:
:undoc-members:
:show-inheritance:
HDF5 Writer
==========================
.. automodule:: src.hdf5_writer
:members:
:undoc-members:
:show-inheritance:
HDF5 Data Operations
==========================
.. automodule:: src.hdf5_ops
:members:
:undoc-members:
:show-inheritance:
HDF5 Writer
==========================
.. automodule:: src.hdf5_writer
:members:
:undoc-members:
:show-inheritance:

12
docs/source/modules/utils.rst
View File

@ -1,7 +1,7 @@
Data Structure Conversion
=========================
.. automodule:: utils.g5505_utils
:members:
:undoc-members:
Data Structure Conversion
=========================
.. automodule:: utils.g5505_utils
:members:
:undoc-members:
:show-inheritance:

12
docs/source/modules/vis.rst
View File

@ -1,7 +1,7 @@
Data Visualization
==================
.. automodule:: visualization.hdf5_vis
:members:
:undoc-members:
Data Visualization
==================
.. automodule:: visualization.hdf5_vis
:members:
:undoc-members:
:show-inheritance: