From 0ba5bcb948f0fda2a859a7a781f4baff8764ff2e Mon Sep 17 00:00:00 2001 From: Melissa DeLucchi <113376043+delucchi-cmu@users.noreply.github.com> Date: Thu, 4 Jan 2024 08:31:53 -0500 Subject: [PATCH] Apply template v.1.4.6 (#198) --- .copier-answers.yml | 3 +-- .git_archival.txt | 4 ++++ .gitattributes | 24 ++++++++++++++++++++++++ docs/conf.py | 11 ++++++----- docs/requirements.txt | 2 -- pyproject.toml | 5 ----- 6 files changed, 35 insertions(+), 14 deletions(-) create mode 100644 .git_archival.txt create mode 100644 .gitattributes diff --git a/.copier-answers.yml b/.copier-answers.yml index 1f1545a7..c8a0a6c6 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,5 +1,5 @@ # Changes here will be overwritten by Copier -_commit: v1.4.4 +_commit: v1.4.6 _src_path: gh:lincc-frameworks/python-project-template author_email: lincc-frameworks-team@lists.lsst.org author_name: LINCC Frameworks @@ -14,5 +14,4 @@ preferred_linter: pylint project_license: BSD project_name: hipscat-import project_organization: astronomy-commons -use_gitlfs: none use_isort: true diff --git a/.git_archival.txt b/.git_archival.txt new file mode 100644 index 00000000..b1a286bb --- /dev/null +++ b/.git_archival.txt @@ -0,0 +1,4 @@ +node: $Format:%H$ +node-date: $Format:%cI$ +describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$ +ref-names: $Format:%D$ \ No newline at end of file diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..343a7554 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,24 @@ +# For explanation of this file and uses see +# https://git-scm.com/docs/gitattributes +# https://developer.lsst.io/git/git-lfs.html#using-git-lfs-enabled-repositories +# https://lincc-ppt.readthedocs.io/en/latest/practices/git-lfs.html +# +# Used by https://github.com/lsst/afwdata.git +# *.boost filter=lfs diff=lfs merge=lfs -text +# *.dat filter=lfs diff=lfs merge=lfs -text +# *.fits filter=lfs diff=lfs merge=lfs -text +# *.gz filter=lfs diff=lfs merge=lfs -text +# +# apache parquet files +# *.parq filter=lfs diff=lfs merge=lfs -text +# +# sqlite files +# *.sqlite3 filter=lfs diff=lfs merge=lfs -text +# +# gzip files +# *.gz filter=lfs diff=lfs merge=lfs -text +# +# png image files +# *.png filter=lfs diff=lfs merge=lfs -text + +.git_archival.txt export-subst \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 7617cc6e..836f4b84 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -8,8 +8,6 @@ import sys from importlib.metadata import version -import autoapi - # Define path to the code to be documented **relative to where conf.py (this file) is kept** sys.path.insert(0, os.path.abspath("../src/")) @@ -34,9 +32,12 @@ templates_path = [] exclude_patterns = ["_build", "**.ipynb_checkpoints"] -master_doc = "index" # This assumes that sphinx-build is called from the root directory -html_show_sourcelink = False # Remove 'view source code' from top of page (for html, not python) -add_module_names = False # Remove namespaces from class/method signatures +# This assumes that sphinx-build is called from the root directory +master_doc = "index" +# Remove 'view source code' from top of page (for html, not python) +html_show_sourcelink = False +# Remove namespaces from class/method signatures +add_module_names = False autoapi_type = "python" autoapi_dirs = ["../src"] diff --git a/docs/requirements.txt b/docs/requirements.txt index 62972b9c..e4a22bb3 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -5,5 +5,3 @@ nbsphinx ipython jupytext jupyter -matplotlib -numpy diff --git a/pyproject.toml b/pyproject.toml index 5715c981..d0263a6c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -49,15 +49,10 @@ dev = [ "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation "ipykernel", # Also used in building notebooks into Sphinx "ipython", # Also used in building notebooks into Sphinx - "matplotlib", # Used in sample notebook intro_notebook.ipynb "ray", # Used for dask-on-ray testing. "types-PyYAML", # type stubs for pyyaml ] -[metadata] -long_description = { file = "README.md" } -url = "https://github.com/astronomy-commons/hipscat-import" - [build-system] requires = [ "setuptools>=62", # Used to build and package the Python project