New: documentation

README.rst

@@ -1,4 +1,4 @@
-anisotrope-cube
+anisotropy
 ===============
 
 Requirements

anisotropy/__init__.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-
+"""asd"""
 from anisotropy.core import (
     Anisotropy,
     logger

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/anisotropy.rst

@@ -0,0 +1,61 @@
+anisotropy package
+==================
+
+Submodules
+----------
+
+anisotropy.bodyCentered module
+------------------------------
+
+.. automodule:: anisotropy.bodyCentered
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.core module
+----------------------
+
+.. automodule:: anisotropy.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.faceCentered module
+------------------------------
+
+.. automodule:: anisotropy.faceCentered
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.models module
+------------------------
+
+.. automodule:: anisotropy.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.simple module
+------------------------
+
+.. automodule:: anisotropy.simple
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.utils module
+-----------------------
+
+.. automodule:: anisotropy.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: anisotropy
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/conf.py

@@ -0,0 +1,54 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'anisotropy'
+copyright = '2021, George Kusayko'
+author = 'George Kusayko'
+
+# The full version, including alpha/beta/rc tags
+release = '1.1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ["sphinx.ext.autodoc"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,22 @@
+.. anisotropy documentation master file, created by
+   sphinx-quickstart on Mon Aug  9 23:39:16 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to anisotropy's documentation!
+======================================
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    modules 
+
+.. include:: ../../README.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,9 @@
+anisotropy
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   anisotropy
+   salomepl
+   openfoam

docs/source/openfoam.rst

@@ -0,0 +1,69 @@
+openfoam package
+================
+
+Submodules
+----------
+
+openfoam.application module
+---------------------------
+
+.. automodule:: openfoam.application
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openfoam.meshConversion module
+------------------------------
+
+.. automodule:: openfoam.meshConversion
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openfoam.meshManipulation module
+--------------------------------
+
+.. automodule:: openfoam.meshManipulation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openfoam.miscellaneous module
+-----------------------------
+
+.. automodule:: openfoam.miscellaneous
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openfoam.parallelProcessing module
+----------------------------------
+
+.. automodule:: openfoam.parallelProcessing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openfoam.solvers module
+-----------------------
+
+.. automodule:: openfoam.solvers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openfoam.utils module
+---------------------
+
+.. automodule:: openfoam.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: openfoam
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/salomepl.rst

@@ -0,0 +1,37 @@
+salomepl package
+================
+
+Submodules
+----------
+
+salomepl.geometry module
+------------------------
+
+.. automodule:: salomepl.geometry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+salomepl.mesh module
+--------------------
+
+.. automodule:: salomepl.mesh
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+salomepl.utils module
+---------------------
+
+.. automodule:: salomepl.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: salomepl
+   :members:
+   :undoc-members:
+   :show-inheritance:

notes/sphinx.rst

@@ -0,0 +1,9 @@
+sphinx
+======
+
+.. code_block:: bash
+    :lineos:
+
+    sphinx-apidoc -o docs/source/ ./
+    cd docs
+    make html

requirements.txt

@@ -3,3 +3,5 @@ pyquaternion
 toml
 peewee
 pandas
+Sphinx
+sphinx-rtd-theme