attempt readthedocs

9 files changed, 196 insertions, 0 deletions

diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png
new file mode 100644
index 0000000..c697e5a
--- /dev/null
+++ b/docs/source/_static/logo.png
diff --git a/docs/source/api.rst b/docs/source/api.rst
new file mode 100644
index 0000000..c9a5f05
--- /dev/null
+++ b/docs/source/api.rst
@@ -0,0 +1,7 @@
+.. _api:
+
+:github_url: https://github.com/ShiveshM/GolemFlavor
+
+***
+API
+***
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..299be37
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,111 @@
+# -*- coding: utf-8 -*-
+#
+# 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
+import golemflavor
+sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'GolemFlavor'
+copyright = u'2020, Shivesh Mandalia'
+author = u'Shivesh Mandalia'
+
+# The full version, including alpha/beta/rc tags
+release = golemflavor.__version__
+
+
+# -- 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',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosummary',
+    'numpydoc',
+    'nbsphinx',
+    'sphinx.ext.mathjax'
+]
+
+numpydoc_show_inherited_class_members = False
+# this is needed for some reason...
+# see https://github.com/numpy/numpydoc/issues/69
+numpydoc_class_members_toctree = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# 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 = ['scripts', u'_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'default'
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+html_show_copyright = True
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = False
+
+# -- 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"
+html_logo = "_static/logo.png"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+    'logo_only': False,
+    'display_version': False,
+    'prev_next_buttons_location': False,
+}
+
+# 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']
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+html_sidebars = {
+    "**": [
+        "searchbox.html",
+    ],
+}
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'GolemFlavordoc'
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
new file mode 100644
index 0000000..df8023f
--- /dev/null
+++ b/docs/source/examples.rst
@@ -0,0 +1,7 @@
+.. _examples:
+
+:github_url: https://github.com/ShiveshM/GolemFlavor
+
+********
+Examples
+********
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..84454ff
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,43 @@
+.. GolemFlavor documentation master file, created by
+   sphinx-quickstart on Mon Mar  2 19:03:06 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+:github_url: https://github.com/ShiveshM/GolemFlavor
+
+GolemFlavor
+===========
+
+GolemFlavor is a Python package for running a Bayesian inference analysis
+pipeline using Astrophysical Flavor data taken at the `IceCube Neutrino
+Obervatory <https://icecube.wisc.edu/>`_
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Getting Started
+
+   overview
+   installation
+   examples
+
+.. toctree::
+   :maxdepth: 1
+   :caption: User Guide
+
+   api
+   physics
+   statistics
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Useful links
+
+   GolemFlavor @ GitHub <https://github.com/ShiveshM/GolemFlavor>
+   Issue Tracker <https://github.com/ShiveshM/GolemFlavor/issues>
+
+Questions & Bug Reports
+-----------------------
+
+If you have a question, would like to propose a new feature, or submit a bug
+report, feel free to open up an issue on the `issue tracker on GitHub
+<https://github.com/ShiveshM/GolemFlavor/issues>`_.
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
new file mode 100644
index 0000000..51a9e01
--- /dev/null
+++ b/docs/source/installation.rst
@@ -0,0 +1,7 @@
+.. _installation:
+
+:github_url: https://github.com/ShiveshM/GolemFlavor
+
+************
+Installation
+************
diff --git a/docs/source/overview.rst b/docs/source/overview.rst
new file mode 100644
index 0000000..e09628e
--- /dev/null
+++ b/docs/source/overview.rst
@@ -0,0 +1,7 @@
+.. _overview:
+
+:github_url: https://github.com/ShiveshM/GolemFlavor
+
+********
+Overview
+********
diff --git a/docs/source/physics.rst b/docs/source/physics.rst
new file mode 100644
index 0000000..528215d
--- /dev/null
+++ b/docs/source/physics.rst
@@ -0,0 +1,7 @@
+.. _physics:
+
+:github_url: https://github.com/ShiveshM/GolemFlavor
+
+*******
+Physics
+*******
diff --git a/docs/source/statistics.rst b/docs/source/statistics.rst
new file mode 100644
index 0000000..4b45795
--- /dev/null
+++ b/docs/source/statistics.rst
@@ -0,0 +1,7 @@
+.. _statistics:
+
+:github_url: https://github.com/ShiveshM/GolemFlavor
+
+**********
+Statistics
+**********