sphinx conf: remove unused sections (#22)

docs/sphinx/conf.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
 # s2sphere documentation build configuration file, created by
@@ -13,21 +12,17 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
+import sys
 
-# extract version from __init__.py
-s2sphere_init_filename = os.path.join(
-  os.path.dirname(__file__), '..', '..', 's2sphere', '__init__.py',
-)
-with open(s2sphere_init_filename, 'r') as f:
-    version_line = [l for l in f if l.startswith('__version__')][0]
-    S2SPHERE_VERSION = version_line.split('=')[1].strip()[1:-1]
 
 # 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.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../..'))
+import s2sphere
+S2SPHERE_VERSION = s2sphere.__version__
+
 
 # -- General configuration ------------------------------------------------
 
@@ -45,6 +40,15 @@
     'sphinx.ext.viewcode',
 ]
 
+primary_domain = 'py'
+default_role = 'py:obj'
+
+autodoc_member_order = 'bysource'
+autoclass_content = 'both'
+
+# workaround: fix builds with the 'viewcode' extension on readthedocs
+autodoc_docstring_signature = False
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -62,7 +66,6 @@
 # General information about the project.
 project = 's2sphere'
 copyright = '2016, The s2sphere authors'
-author = 'Jonathan Gillham, Sven Kreiss, Alexander Mohr, Dan Vanderkam'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -107,7 +110,7 @@
 #show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+#pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
@@ -152,7 +155,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -185,7 +188,7 @@
 #html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-html_show_sourcelink = False
+#html_show_sourcelink = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 html_show_sphinx = False
@@ -218,84 +221,3 @@
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 's2spheredoc'
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-
-# Latex figure (float) alignment
-#'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, 's2sphere.tex', 's2sphere Documentation',
-     'Jonathan Gillham, Sven Kreiss, Alexander Mohr, Dan Vanderkam', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 's2sphere', 's2sphere Documentation',
-     [author], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (master_doc, 's2sphere', 's2sphere Documentation',
-     author, 's2sphere', 'One line description of project.',
-     'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False

docs/sphinx/index.rst

@@ -40,4 +40,3 @@ Contents
     cpp
 
 * :ref:`genindex`
-

docs/sphinx/requirements.txt

@@ -0,0 +1 @@
+Sphinx>=1.4.1