Djalim Simaila
be673c97aa
The Sphinx documentation has been added to the project. This includes a Makefile, a make.bat file, and a conf.py file in the docs directory. The source directory contains the documentation files in reStructuredText format. The documentation includes an installation guide and an API reference. The utils package has been reorganized to be more modular and easier to document. The documentation can be built using the `make html` command in the docs directory.
🎉 feat(utils): add new modules and packages to the project
New modules and packages have been added to the project. The following packages have been added:
- utils.gui.pyqt.about
- utils.gui.pyqt.error_popup
- utils.gui.pyqt.main_window
- utils.gui.pyqt.settings
- utils.math
- utils.settings
The new packages contain modules that provide additional functionality to the project.
31 lines
834 B
ReStructuredText
31 lines
834 B
ReStructuredText
.. Analyse Morphologique documentation master file, created by
|
|
sphinx-quickstart on Tue May 16 10:01:13 2023.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to Analyse Morphologique's documentation!
|
|
=================================================
|
|
|
|
"Analyse Morphologique" (Morphological Analysis) is a tool developed by the Geomechanics Laboratory of INRAE PACA Center. Its goal is to extract information about the morphology of 3D scans from HET (Hydraulic Erosion Test) tests.
|
|
Check out the :doc:`installation` section for further information.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|
|
Contents
|
|
--------
|
|
|
|
.. toctree::
|
|
|
|
installation
|
|
api |