Merge pull request #20 from OMalenfantThuot/doc

Doc
OMalenfantThuot · Oct 24, 2019 · e944b97 · e944b97
2 parents 75316b1 + a837f8f
commit e944b97
Show file tree

Hide file tree

Showing 93 changed files with 20,499 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# ML\_Calc\_Driver
+# Machine Learning Calculations Driver (ML\_Calc\_Driver)
 
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
 [![Build Status](https://travis-ci.org/OMalenfantThuot/ML_Calc_Driver.svg?branch=master&kill_cache=1)](https://travis-ci.org/OMalenfantThuot/ML_Calc_Driver)
@@ -18,7 +18,7 @@ which served as a foundation for this work. Some classes have been directly adap
 
 ## Documentation
 
-No documentation for the moment.
+The documentation is available [here](https://omalenfantthuot.github.io/ML_Calc_Driver/).
 
 ## Installation
 

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b2854b42d84965a2e3ec8eeeaf37d586
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,24 @@
+# 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)
+
+github:
+	@make html
+	@cp -a build/html/. ../docs
diff --git a/docs/_sources/base.rst.txt b/docs/_sources/base.rst.txt
@@ -0,0 +1,11 @@
+Base Module
+-----------
+
+.. automodule:: mlcalcdriver.base
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Related classes
+
+   posinp
+   job
diff --git a/docs/_sources/calculators.rst.txt b/docs/_sources/calculators.rst.txt
@@ -0,0 +1,4 @@
+Calculators
+-----------
+
+.. automodule:: mlcalcdriver.calculators
diff --git a/docs/_sources/globals.rst.txt b/docs/_sources/globals.rst.txt
@@ -0,0 +1,3 @@
+Globals
+-------
+
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,27 @@
+.. ML_Calc_Driver documentation master file, created by
+   sphinx-quickstart on Wed Oct 23 15:50:30 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ML_Calc_Driver's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Modules:
+
+   base
+   calculators
+   globals
+   interfaces
+   workflows
+
+.. mdinclude:: ../../README.md
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/interfaces.rst.txt b/docs/_sources/interfaces.rst.txt
@@ -0,0 +1,4 @@
+Interfaces
+----------
+
+.. automodule:: mlcalcdriver.interfaces
diff --git a/docs/_sources/job.rst.txt b/docs/_sources/job.rst.txt
@@ -0,0 +1,6 @@
+Job Object
+----------
+
+.. autoclass:: mlcalcdriver.base.Job
+
+.. autoclass:: mlcalcdriver.base.JobResults
diff --git a/docs/_sources/posinp.rst.txt b/docs/_sources/posinp.rst.txt
@@ -0,0 +1,6 @@
+Posinp and Atom Objects
+-----------------------
+
+.. autoclass:: mlcalcdriver.base.Posinp
+
+.. autoclass:: mlcalcdriver.base.Atom
diff --git a/docs/_sources/workflows.rst.txt b/docs/_sources/workflows.rst.txt
@@ -0,0 +1,4 @@
+Workflows
+---------
+
+.. automodule:: mlcalcdriver.workflows