From 5ce3f3539822b4ca0fb6f281a92c94274860d5bb Mon Sep 17 00:00:00 2001
From: Gregory Ashton <gregory.ashton@ligo.org>
Date: Fri, 25 May 2018 13:08:10 +1000
Subject: [PATCH] First attempt to show how to use docs
---
docs/conf.py | 10 +++++-----
docs/index.txt | 11 +++++------
docs/likelihood.txt | 8 ++++++++
tupak/__init__.py | 11 +++++++++++
4 files changed, 29 insertions(+), 11 deletions(-)
create mode 100644 docs/likelihood.txt
diff --git a/docs/conf.py b/docs/conf.py
index 5e232e36f..153acc8d6 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -16,9 +16,9 @@
# 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('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../tupak/'))
# -- General configuration ------------------------------------------------
@@ -30,8 +30,8 @@
# 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.mathjax']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax', 'numpydoc',
+ 'nbsphinx']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
diff --git a/docs/index.txt b/docs/index.txt
index 37c29ddd0..ca73c9c9e 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -1,15 +1,14 @@
-.. tupak documentation master file, created by
- sphinx-quickstart on Fri May 25 12:08:01 2018.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
Welcome to tupak's documentation!
=================================
+.. automodule:: tupak
+ :members:
+
.. toctree::
- :maxdepth: 2
+ :maxdepth: 3
:caption: Contents:
+ likelihood
Indices and tables
diff --git a/docs/likelihood.txt b/docs/likelihood.txt
new file mode 100644
index 000000000..3caa397e4
--- /dev/null
+++ b/docs/likelihood.txt
@@ -0,0 +1,8 @@
+==========
+Likelihood
+==========
+
+.. automodule:: tupak.likelihood
+ :members:
+
+
diff --git a/tupak/__init__.py b/tupak/__init__.py
index 0f57bbb4f..5716af07d 100644
--- a/tupak/__init__.py
+++ b/tupak/__init__.py
@@ -1,3 +1,14 @@
+"""
+tupak
+=====
+
+Tupak is The User friendly Parameter estimAtion Kode
+
+FILL IN THE REST
+
+"""
+
+
from __future__ import print_function, division
# import local files, utils should be imported first
--
GitLab