Skip to content
Snippets Groups Projects
Commit 5ce3f353 authored by Gregory Ashton's avatar Gregory Ashton
Browse files

First attempt to show how to use docs

parent ba2fc702
No related branches found
No related tags found
1 merge request!49Adding documentation
......@@ -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']
......
.. 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
......
==========
Likelihood
==========
.. automodule:: tupak.likelihood
:members:
"""
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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment