diff --git a/.gitignore b/.gitignore index 222931f853f9ddf2e25dbfb6c26f1051c456bef4..01ddc9738bb3f02979d4d49d9f61f7d9e53ea9d7 100644 --- a/.gitignore +++ b/.gitignore @@ -63,4 +63,8 @@ report.html # secret variables # #################### -/src/join_settings.py \ No newline at end of file +/src/join_settings.py + +# ignore locally build documentation # +###################################### +/docs/_build diff --git a/docs/_source/_api/machinelearningtools.rst b/docs/_source/_api/machinelearningtools.rst new file mode 100644 index 0000000000000000000000000000000000000000..cd6885f52bedfa295139251c641c5bba8e2a30e9 --- /dev/null +++ b/docs/_source/_api/machinelearningtools.rst @@ -0,0 +1,10 @@ +machinelearningtools package +============================ + +.. automodule:: src + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- diff --git a/docs/_source/api.rst b/docs/_source/api.rst new file mode 100644 index 0000000000000000000000000000000000000000..63db2308c7ac34ddaa7e498e62356066d4c2c811 --- /dev/null +++ b/docs/_source/api.rst @@ -0,0 +1,9 @@ +Package Reference +================= + +Information on specific functions, classes, and methods. + +.. toctree:: + :glob: + + _api/* \ No newline at end of file diff --git a/docs/_source/get-started.rst b/docs/_source/get-started.rst new file mode 100644 index 0000000000000000000000000000000000000000..e5a82fdcf1d16ca2188a04e3dce76dc7ba9d477a --- /dev/null +++ b/docs/_source/get-started.rst @@ -0,0 +1,16 @@ +Get started with MachineLearningTools +===================================== + +<what is machinelearningtools?> + +MLT Module and Funtion Documentation +------------------------------------ + +Install MachineLearningTools +---------------------------- + +Dependencies +~~~~~~~~~~~~ + +Data +~~~~