Commit 693bedbc authored by Jacob Kaufman's avatar Jacob Kaufman
Browse files

Updating Jupyter Docs

parent b8a8f642
Loading
Loading
Loading
Loading

jupyter/docs/Demo/demo.ipynb

deleted100644 → 0
+0 −54
Original line number Diff line number Diff line
%% Cell type:code id: tags:

``` python
# This is used to install all the correct packages using pip
import sys
!{sys.executable} -m pip install ipywidgets
!{sys.executable} -m pip install ipyleaflet
!{sys.executable} -m pip install geojson
!{sys.executable} -m pip install shapely
```

%% Cell type:code id: tags:

``` python
import os
import sys
module_path = os.path.abspath(os.path.join('../src/'))
if module_path not in sys.path:
    sys.path.append(module_path)
```

%% Cell type:code id: tags:

``` python
import CartoCosmos as l

# Create the leaflet map
map = l.planetary_maps('mars')

# Display the map and buttons
map.display_map()
```

%% Output









%% Cell type:code id: tags:

``` python
# Add a polygon to the album by passing in a WKT
map.add_wkt("POLYGON ((-187.03125 22.851563, -187.03125 35.15625, -167.34375 35.15625, -167.34375 22.851563, -187.03125 22.851563))")
```

%% Cell type:code id: tags:

``` python
```
+0 −7
Original line number Diff line number Diff line
CartoCosmos module
==================

.. automodule:: CartoCosmos
   :members:
   :undoc-members:
   :show-inheritance:
+0 −24
Original line number Diff line number Diff line
.. _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

jupyter/docs/Source/conf.py

deleted100644 → 0
+0 −39
Original line number Diff line number Diff line
# 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']
−2.57 MiB
Loading image diff...
Loading