From f4ab1d6787b5752b2de4a75e03b9f0fca6fa1d9f Mon Sep 17 00:00:00 2001 From: Andrew Hearin Date: Sun, 8 Sep 2024 12:37:02 -0500 Subject: [PATCH] Whoops restore conf.py and delete setup.cfg --- docs/conf.py | 108 +++++++++++++++++++++++++++++++++++++++++++++++++++ setup.cfg | 54 -------------------------- 2 files changed, 108 insertions(+), 54 deletions(-) create mode 100644 docs/conf.py delete mode 100644 setup.cfg diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..930321ed4 --- /dev/null +++ b/docs/conf.py @@ -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 +# " v 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 --------------------------------- diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 91407e1b9..000000000 --- a/setup.cfg +++ /dev/null @@ -1,54 +0,0 @@ -[metadata] -name = halotools -author = Andrew Hearin -author_email = ahearin@anl.gov -license = BSD 3-Clause -license_files = licenses/LICENSE.rst -url = http://astropy.org -description = Package designed to analyze N-body simulations and constrain models of cosmology and galaxy evolution. -long_description = file: README.rst -long_description_content_type = text/x-rst -edit_on_github = False -github_project = astropy/halotools - -[options] -zip_safe = False -packages = find: -python_requires = >=3.10 -setup_requires = setuptools_scm -install_requires = - astropy - numpy<2 - scipy - requests - beautifulsoup4 - cython - h5py - -[options.extras_require] -all = - h5py -test = - pytest-astropy - h5py -docs = - sphinx-astropy - -[options.package_data] -halotools = - data/* - utils/tests/data/* - sim_manager/tests/data/* - empirical_models/phase_space_models/analytic_models/satellites/nfw/kernels/tests/data/* - - -[tool:pytest] -testpaths = "halotools" "docs" -astropy_header = true -doctest_plus = enabled -text_file_format = rst -addopts = --doctest-rst -markers = - slow - installation_test -