Merge pull request #72 from jkaufy/master

# Minimal makefile for Sphinx documentation

#

# You can set these variables from the command line, and also

# from the environment for the first two.

SPHINXOPTS    ?=

SPHINXBUILD   ?= sphinx-build

SOURCEDIR     = .

BUILDDIR      = _build

# Put it first so that "make" without argument is like "make help".

help:

	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new

# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

%: Makefile

	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

CartoCosmos module

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

.. automodule:: CartoCosmos

   :members:

   :undoc-members:

   :show-inheritance:

.. _installation:

Using pip

=========

.. code:: bash

    Coming Soon

Using conda

===========

.. code:: bash

    Coming Soon

JupyterLab extension

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

If you have JupyterLab, you will also need to install the JupyterLab extension:

.. code:: bash

    Coming Soon

# 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

sys.path.append("/Users/jkaufy/Desktop/Pydocs/sphinx/Scripts")

extensions = [

             'jupyter_sphinx',

             'sphinx.ext.autodoc',

             ]

templates_path = ['_templates']

master_doc = 'index'

source_suffix = '.rst'

# General information about the project.

project = 'CartoCosmos'

author = 'CartoCosmos Development Team'

exclude_patterns = []

highlight_language = 'python'

pygments_style = 'sphinx'

# Output file base name for HTML help builder.

html_theme = "default"

htmlhelp_basename = 'CartoCosmosDoc'

html_static_path = ['_static']