Skip to content
Permalink
Browse files

Add documentation

  • Loading branch information...
johmathe committed Jul 26, 2019
1 parent 27667a9 commit b85a477092513ccd10da20d6497b1d858990ab8c
Showing with 158 additions and 0 deletions.
  1. +19 −0 docs/Makefile
  2. +7 −0 docs/api-reference.rst
  3. +12 −0 docs/changelog.rst
  4. +58 −0 docs/conf.py
  5. +34 −0 docs/index.rst
  6. +12 −0 docs/install.rst
  7. +8 −0 docs/requirements.doc.txt
  8. +4 −0 docs/troubleshooting.rst
  9. +4 −0 docs/tutorials.rst
@@ -0,0 +1,19 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
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)
@@ -0,0 +1,7 @@
API Reference
=============

Here is the definition of the main client library:

.. autoclass:: geomstats.manifold.Manifold
:members: regularize
@@ -0,0 +1,12 @@
Changelog
=========

**0.1.7**

* Bugfixes
* Default arguments on the API
* Better command line argument parsing

**0.1.6**

* Cleaner API.
@@ -0,0 +1,58 @@
project = 'Geomstats'
copyright = '2019, Geomstats, Inc.'
author = 'Geomstats Team'

version = '0.1'
# The full version, including alpha/beta/rc tags
release = '0.1'


extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
]

templates_path = ['templates']

source_suffix = '.rst'

master_doc = 'index'

language = None

exclude_patterns = ['build', 'Thumbs.db', '.DS_Store']

pygments_style = None

html_theme = 'sphinx_rtd_theme'

html_static_path = ['static']

htmlhelp_basename = 'geomstatsdoc'

latex_elements = {
}


latex_documents = [
(master_doc, 'geomstats.tex', 'geomstats Documentation',
'Geomstats Team', 'manual'),
]

man_pages = [
(master_doc, 'geomstats', 'geomstats Documentation',
[author], 1)
]

texinfo_documents = [
(master_doc, 'geomstats', 'geomstats Documentation',
author, 'geomstats', 'One line description of project.',
'Miscellaneous'),
]

epub_title = project
epub_exclude_files = ['search.html']
@@ -0,0 +1,34 @@
Geomstats
=========

*Geomstats does some cool stuff.*

Familiar user interface
-----------------------

**Quick install**

.. code-block:: bash
pip install geomstats
**A python exampple.**
.. code-block:: python
import geomstats as gs
.. toctree::
:maxdepth: 1
:caption: Getting Started

install.rst
api-reference.rst
tutorials.rst
changelog.rst

.. toctree::
:maxdepth: 1
:caption: Support

troubleshooting.rst
@@ -0,0 +1,12 @@
Install Geomstats
=================


You can install geomstats with ``pip``, or by installing from source.

Pip
---

You can install geomstats as follow::

pip install geomstats
@@ -0,0 +1,8 @@
numpydoc==0.8
sphinx
dask_sphinx_theme>=1.1.0
sphinx-click
toolz
cloudpickle
pandas>=0.19.0
distributed
@@ -0,0 +1,4 @@
Troubleshooting
===============

Trouble shooting.
@@ -0,0 +1,4 @@
Tutorials
=========


0 comments on commit b85a477

Please sign in to comment.
You can’t perform that action at this time.