started implementing some automatic docstrings with extremely simplistic usage of sphinx directives

# 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('../..'))

import sphinx_rtd_theme

def setup(app):

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.

extensions = ['sphinx.ext.autodoc',

              'sphinx.ext.napoleon',

    'sphinx.ext.doctest',

    'sphinx.ext.intersphinx',

    'sphinx.ext.todo',

  package/guide

Package-name documentation

Project-name documentation

==========================

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

These are all the packages, functions and scripts that form part of the project.

- :doc:`package/guide`

========

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Public API Documentation

````````````````````````

Functions

---------

.. automodule:: ska_python_skeleton.main

    :members:

Classes

-------

.. autoclass:: ska_python_skeleton.main.SKA

    :noindex:

    :members:

# -*- coding: utf-8 -*-

#"""Define function placeholders and test function examples."""

# TODO: Replace all the following code with the desired functionality for the package

def function_example():

    """Example: function outside of a class"""

# TODO: Replace all the following code with the desired functionality for the package

class SKA():

    """Define class and it's attributes"""

    def example(self):

        """Example: Define non return function for subsequent test."""

    def testing_example(self):

        """Example: Define function for subsequent test with specific return value."""

        return 2

# -*- coding: utf-8 -*-

"""Define function placeholders and test function examples."""

# TODO: Replace all the following code with the desired functionality for the package

def example():

    """Example: Define non return function for subsequent test."""

def testing_example():

    """Example: Define function for subsequent test with specific return value."""

    return 2