Commit 5d177861 authored by Lauren Adoram-Kershner's avatar Lauren Adoram-Kershner Committed by GitHub
Browse files

Readthedocs (#404) 

* remove a possibly unecessary import

* stealing plio conf.py and RTD yaml

* using sphinx-quickstart to create conf.py

* removing index_new.rst as master doc

* typo

* comment edits
parent 9344dd42

.readthedocs.yaml

0 → 100644
+18 −0
Original line number Diff line number Diff line 
# .readthedocs.yaml

# Read the Docs configuration file

# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details



# Required

version: 2



# Build documentation in the docs/ directory with Sphinx

sphinx:

   configuration: docs/conf.py



# Optionally build your docs in additional formats such as PDF

formats:

   - pdf



conda:

  environment: environment.yml

docs/conf.py

0 → 100644
+58 −0
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.insert(0, os.path.abspath('.'))





# -- Project information -----------------------------------------------------



project = 'Abstraction Layer for Ephemerides (ALE)'

copyright = '2021, USGS-Astrogeology Science Center'

author = 'USGS-Astrogeology Science Center'



# The full version, including alpha/beta/rc tags

release = 'ale.__version__'





# -- General configuration ---------------------------------------------------



# Add any Sphinx extension module names here, as strings. They can be

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.

extensions = [

]



# Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']



# The master toctree document.

master_doc = 'index'



# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

# This pattern also affects html_static_path and html_extra_path.

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





# -- Options for HTML output -------------------------------------------------



# The theme to use for HTML and HTML Help pages.  See the documentation for

# a list of builtin themes.

#

html_theme = 'alabaster'



# 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']

docs/index.rst

0 → 100644
+11 −0
Original line number Diff line number Diff line 
#############################

Abstraction Layer for Ephemerides (ALE)

#############################



:Release: |version|

:Date: |today|



.. toctree::

   :maxdepth: 3



   source/index

docs/make.bat

0 → 100644
+35 −0
Original line number Diff line number Diff line 
@ECHO OFF



pushd %~dp0



REM Command file for Sphinx documentation



if "%SPHINXBUILD%" == "" (

	set SPHINXBUILD=sphinx-build

)

set SOURCEDIR=.

set BUILDDIR=_build



if "%1" == "" goto help



%SPHINXBUILD% >NUL 2>NUL

if errorlevel 9009 (

	echo.

	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx

	echo.installed, then set the SPHINXBUILD environment variable to point

	echo.to the full path of the 'sphinx-build' executable. Alternatively you

	echo.may add the Sphinx directory to PATH.

	echo.

	echo.If you don't have Sphinx installed, grab it from

	echo.http://sphinx-doc.org/

	exit /b 1

)



%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

goto end



:help

%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%



:end

popd

docs/source/conf.py

deleted100644 → 0
+0 −199
Original line number Diff line number Diff line 
# -*- coding: utf-8 -*-

#

# Configuration file for the Sphinx documentation builder.

#

# This file does only contain a selection of the most common options. For a

# full list see the documentation:

# http://www.sphinx-doc.org/en/master/config



# -- 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.insert(0, os.path.abspath('.'))

import guzzle_sphinx_theme







# -- Project information -----------------------------------------------------



project = 'ALE'

copyright = 'Public Domain'

author = 'USGS, Astrogeology Science Center'



# The short X.Y.Z version

version = '0.8.5'

# The full version, including alpha/beta/rc tags

release = '0.8.5'





# -- General configuration ---------------------------------------------------



# If your documentation needs a minimal Sphinx version, state it here.

#

# needs_sphinx = '1.0'



# Add any Sphinx extension module names here, as strings. They can be

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.



breathe_projects = {"ale": "./../doxyxml/"}



numpydoc_show_class_members = False



breathe_default_project = "ale"



extensions = [

    'sphinx.ext.autodoc',

    'numpydoc',

    'sphinx.ext.intersphinx',

    'sphinx.ext.coverage',

    'sphinx.ext.mathjax',

    'sphinx.ext.viewcode',

    'sphinx.ext.githubpages',

    'breathe'

]



# Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']



# The suffix(es) of source filenames.

# You can specify multiple suffix as a list of string:

#

# source_suffix = ['.rst', '.md']

source_suffix = '.rst'



# The master toctree document.

master_doc = 'index'



# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

#

# This is also used if you do content translation via gettext catalogs.

# Usually you set "language" from the command line for these cases.

language = None



# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

# This pattern also affects html_static_path and html_extra_path.

exclude_patterns = []



# The name of the Pygments (syntax highlighting) style to use.

pygments_style = None





# -- Options for HTML output -------------------------------------------------



# The theme to use for HTML and HTML Help pages.  See the documentation for

# a list of builtin themes.

#



html_theme = "alabaster"



# Theme options are theme-specific and customize the look and feel of a theme

# further.  For a list of options available for each theme, see the

# documentation.



# html_theme_options = {}



# 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']



# Custom sidebar templates, must be a dictionary that maps document names

# to template names.

#

# The default sidebars (for documents that don't match any pattern) are

# defined by theme itself.  Builtin themes are using these templates by

# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',

# 'searchbox.html']``.

#

# html_sidebars = {}





# -- Options for HTMLHelp output ---------------------------------------------



# Output file base name for HTML help builder.

htmlhelp_basename = 'ALEdoc'





# -- 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, 'ALE.tex', 'ALE Documentation',

     author, 'manual'),

]





# -- 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, 'ale', 'ALE Documentation',

     [author], 1)

]





# -- 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, 'ALE', 'ALE Documentation',

     author, 'ALE', 'One line description of project.',

     'Miscellaneous'),

]





# -- Options for Epub output -------------------------------------------------



# Bibliographic Dublin Core info.

epub_title = project



# The unique identifier of the text. This can be a ISBN number

# or the project homepage.

#

# epub_identifier = ''



# A unique identification for the text.

#

# epub_uid = ''



# A list of files that should not be packed into the epub file.

epub_exclude_files = ['search.html']





# -- Extension configuration -------------------------------------------------



# -- Options for intersphinx extension ---------------------------------------



# Example configuration for intersphinx: refer to the Python standard library.

intersphinx_mapping = {'https://docs.python.org/': None}