-
-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Whoops restore conf.py and delete setup.cfg
- Loading branch information
Showing
2 changed files
with
108 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
# -*- coding: utf-8 -*- | ||
# Licensed under a 3-clause BSD style license - see LICENSE.rst | ||
# | ||
|
||
import os | ||
import sys | ||
from datetime import datetime, timezone | ||
from importlib import metadata | ||
|
||
try: | ||
import sphinx_astropy | ||
except ImportError: | ||
# Building from inside the docs/ directory? | ||
if os.path.basename(os.getcwd()) == "docs": | ||
a_h_path = os.path.abspath(os.path.join("..", "sphinx_astropy")) | ||
if os.path.isdir(a_h_path): | ||
sys.path.insert(1, a_h_path) | ||
|
||
# Load all of the global Astropy configuration | ||
from sphinx_astropy.conf.v2 import exclude_patterns | ||
|
||
# -- General configuration ---------------------------------------------------- | ||
|
||
# If your documentation needs a minimal Sphinx version, state it here. | ||
needs_sphinx = "3.0" | ||
|
||
# List of patterns, relative to source directory, that match files and | ||
# directories to ignore when looking for source files. | ||
exclude_patterns.append("_templates") | ||
|
||
|
||
# -- Project information ------------------------------------------------------ | ||
|
||
project = "halotools" | ||
author = "Andrew Hearin" | ||
copyright = f"2017–{datetime.now(tz=timezone.utc).year}, " + author | ||
|
||
# The version info for the project you're documenting, acts as replacement for | ||
# |version| and |release|, also used in various other places throughout the | ||
# built documents. | ||
|
||
release = metadata.version(project) | ||
version = ".".join(release.split(".")[:2]) | ||
|
||
|
||
# -- Options for HTML output -------------------------------------------------- | ||
|
||
# A NOTE ON HTML THEMES | ||
html_theme_options = { | ||
"logotext1": "halo", # white, semi-bold | ||
"logotext2": "tools", # red, light | ||
"logotext3": ":docs", # white, light | ||
} | ||
|
||
# The global astropy configuration uses a custom theme, 'bootstrap-astropy', | ||
# which is installed along with astropy. A different theme can be used or | ||
# the options for this theme can be modified by overriding some of the | ||
# variables set in the global configuration. The variables set in the | ||
# global configuration are listed below, commented out. | ||
|
||
# Add any paths that contain custom themes here, relative to this directory. | ||
# To use a different custom theme, add the directory containing the theme. | ||
# html_theme_path = [] | ||
|
||
# The theme to use for HTML and HTML Help pages. See the documentation for | ||
# a list of builtin themes. To override the custom theme, set this to the | ||
# name of a builtin theme or the name of a custom theme in html_theme_path. | ||
# html_theme = None | ||
|
||
# Custom sidebar templates, maps document names to template names. | ||
# html_sidebars = {} | ||
|
||
# The name of an image file (within the static path) to use as favicon of the | ||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
# pixels large. | ||
# html_favicon = '' | ||
|
||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||
# using the given strftime format. | ||
# html_last_updated_fmt = '' | ||
|
||
# The name for this set of Sphinx documents. If None, it defaults to | ||
# "<project> v<release> documentation". | ||
html_title = f"{project} v{release}" | ||
|
||
# Output file base name for HTML help builder. | ||
htmlhelp_basename = project + "doc" | ||
|
||
# Static files to copy after template files | ||
html_static_path = ["_static"] | ||
html_style = "halotools.css" | ||
|
||
# -- Options for LaTeX output ------------------------------------------------- | ||
|
||
# Grouping the document tree into LaTeX files. List of tuples | ||
# (source start file, target name, title, author, documentclass [howto/manual]) | ||
latex_documents = [ | ||
("index", project + ".tex", project + " 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 = [("index", project.lower(), project + " Documentation", [author], 1)] | ||
|
||
# -- Options for the edit_on_github extension --------------------------------- |