Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add html files for Sphinx docs #43

Merged
merged 3 commits into from
Feb 4, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ __pycache__/
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@ To run the jupiter examples,
2. `pip install jupyter`
2. `jupyter notebook`

## Documentation

Documentation is created using Sphix. View the docs [here]().

To update docs prior to a release:

`cd docs`
`sphinx-apidoc -f -o source/ ../mapboxgl/`
`make html`

## Usage

Import the mapboxgl library and helper functions to start:
Expand Down
29 changes: 29 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = MapboxGLJupyter
SOURCEDIR = source
BUILDDIR = ../docs
PDFBUILDDIR = /tmp
PDF = ../manual.pdf

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(PDFBUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
make -C $(PDFBUILDDIR)/latex all-pdf
cp $(PDFBUILDDIR)/latex/*.pdf $(PDF)
@echo "pdflatex finished; see $(PDF)"

.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)
Binary file added docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/build/doctrees/mapboxgl.doctree
Binary file not shown.
Binary file added docs/build/doctrees/modules.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d28cc8663b8412d811f01097294fc956
tags: 645f666f9bcd5a90fca523b33c5a78b7
20 changes: 20 additions & 0 deletions docs/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. MapboxGL Jupyter documentation master file, created by
sphinx-quickstart on Sat Feb 3 20:01:28 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to MapboxGL Jupyter's documentation!
============================================

.. toctree::
:maxdepth: 2
:caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
54 changes: 54 additions & 0 deletions docs/build/html/_sources/mapboxgl.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
mapboxgl package
================

Submodules
----------

mapboxgl\.colors module
-----------------------

.. automodule:: mapboxgl.colors
:members:
:undoc-members:
:show-inheritance:

mapboxgl\.errors module
-----------------------

.. automodule:: mapboxgl.errors
:members:
:undoc-members:
:show-inheritance:

mapboxgl\.templates module
--------------------------

.. automodule:: mapboxgl.templates
:members:
:undoc-members:
:show-inheritance:

mapboxgl\.utils module
----------------------

.. automodule:: mapboxgl.utils
:members:
:undoc-members:
:show-inheritance:

mapboxgl\.viz module
--------------------

.. automodule:: mapboxgl.viz
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: mapboxgl
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/build/html/_sources/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
mapboxgl
========

.. toctree::
:maxdepth: 4

mapboxgl
Binary file added docs/build/html/_static/ajax-loader.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.