Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix issue where Sphinx config was attempting to read from setup.cfg instead of pyproject.toml #45

Merged
merged 2 commits into from
Jun 7, 2022
Merged

fix issue where Sphinx config was attempting to read from setup.cfg instead of pyproject.toml #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae0558e
fix issue where Sphinx config was attempting to read from `setup.cfg`…
zacharyburnett Jun 7, 2022
5c19b79
update reference files
zacharyburnett Jun 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
from os import PathLike
from pathlib import Path

import toml as toml
from dunamai import Version
from setuptools import config


def repository_root(path: PathLike = None) -> Path:
Expand All @@ -40,10 +40,10 @@ def repository_root(path: PathLike = None) -> Path:
)

# -- Project information -----------------------------------------------------
metadata = config.read_configuration("../../setup.cfg")["metadata"]
metadata = toml.load("../../pyproject.toml")["tool"]["poetry"]

project = metadata["name"]
author = metadata["author"]
author = metadata["authors"][0]
copyright = f"2021, {author}"

# The full version, including alpha/beta/rc tags
Expand All @@ -56,7 +56,8 @@ def repository_root(path: PathLike = None) -> Path:

autoclass_content = "both" # include both class docstring and __init__
autodoc_default_options = {
# Make sure that any autodoc declarations show the right members
# Make sure that any autodoc declar
# ations show the right members
"members": True,
"inherited-members": True,
"private-members": True,
Expand Down
4 changes: 3 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,13 @@ pytest = { version = '*', optional = true }
pytest-cov = { version = '*', optional = true }
pytest-socket = { version = '*', optional = true }
pytest-xdist = { version = '*', optional = true }
dunamai = { version = '*', optional = true }
m2r2 = { version = '*', optional = true }
sphinx = { version = '*', optional = true }
sphinx-rtd-theme = { version = '*', optional = true }
toml = { version = '*', optional = true }

[tool.poetry.extras]
testing = ['pytest', 'pytest-cov', 'pytest-socket', 'pytest-xdist']
development = ['isort', 'black']
documentation = ['m2r2', 'sphinx', 'sphinx-rtd-theme']
documentation = ['dunamai', 'm2r2', 'sphinx', 'sphinx-rtd-theme', 'toml']
2 changes: 1 addition & 1 deletion tests/data/reference/test_coops_stations_within_region/stations.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ nos_id,nws_id,name,state,status,removed,geometry
8726412,MTBF1,Middle Tampa Bay,,active,,POINT (-82.625 27.65625)
8726679,TSHF1,East Bay Causeway,FL,active,,POINT (-82.4375 27.921875)
8726694,TPAF1,TPA Cruise Terminal 2,FL,active,,POINT (-82.4375 27.9375)
8662245,NITS1,Oyster Landing (N Inlet Estuary),SC,active,"2015-12-08 00:00:00,2014-12-05 00:00:00,2013-12-18 00:00:00,2012-08-28 00:00:00,2011-11-04 00:00:00,2010-12-03 00:00:00,2009-12-11 00:00:00,2008-12-22 09:12:00,2008-12-08 00:00:00,2005-10-18 23:59:00,2005-10-18 00:00:00,2004-12-11 00:00:00,2003-11-21 23:59:00,2003-11-21 00:00:00,2002-12-07 00:00:00",POINT (-79.1875 33.34375)
8720233,BLIF1,Blount Island Command,FL,active,"2017-01-16 14:35:00,2017-01-16 14:30:00,2013-11-18 00:00:00,2013-11-15 00:00:00",POINT (-81.5 30.390625)
8720228,LTJF1,Little Jetties Visibility,FL,active,"2017-02-21 18:00:00,2014-02-06 00:00:00",POINT (-81.4375 30.375)
8726520,SAPF1,"St. Petersburg, Tampa Bay",FL,active,"2017-06-30 00:00:00,2017-01-17 00:00:00,2016-01-21 23:58:00,2016-01-13 00:00:00,2016-01-12 23:59:00,2016-01-12 23:58:00,2016-01-12 00:00:00,2015-01-30 00:00:00,2014-02-07 00:00:00,2013-02-19 10:14:00,2012-02-03 09:46:00,2011-03-04 14:08:00,2011-03-03 09:48:00,2010-02-18 23:59:00,2010-02-18 00:00:00,2009-12-17 20:03:00,2009-04-13 00:00:00,2007-02-24 00:00:00,2006-04-14 23:59:00,2006-04-14 00:00:00,2005-02-24 00:00:00,2004-03-14 00:00:00,2003-03-04 00:00:00,2002-03-08 00:00:00,2001-05-02 00:00:00,2000-06-28 00:00:00,2000-04-06 00:00:00,1999-02-17 00:00:00,1998-02-10 00:00:00,1996-07-16 23:00:00,1993-02-25 23:00:00,1992-12-16 00:00:00,1992-04-16 23:00:00",POINT (-82.625 27.765625)
Expand Down Expand Up @@ -44,3 +43,4 @@ nos_id,nws_id,name,state,status,removed,geometry
8654400,CFPN7,Cape Hatteras Fishing Pier,NC,discontinued,"2018-09-19 23:59:00,2003-09-18 23:59:00,2003-09-18 00:00:00,2003-04-14 00:00:00,2002-08-22 00:00:00,2001-04-04 00:00:00,2001-02-01 00:00:00,2000-07-12 00:00:00,1998-03-31 00:00:00,1997-04-21 00:00:00,1994-10-06 00:00:00,1993-03-15 23:59:00,1993-03-15 23:00:00,1993-03-15 00:00:00,1991-03-12 00:00:00",POINT (-75.625 35.21875)
8720625,RCYF1,"Racy Point, St Johns River",FL,discontinued,"2019-08-05 14:00:00,2017-06-14 15:36:00,2017-01-14 18:15:00,2016-01-16 12:00:00,2015-08-06 20:00:00,2015-01-14 09:08:00,2013-11-24 00:01:00,2013-11-24 00:00:00,2008-08-18 23:59:00,2008-08-18 00:00:00,1997-07-10 23:59:00,1997-07-10 00:00:00",POINT (-81.5625 29.796875)
8726667,MCYF1,Mckay Bay Entrance,FL,discontinued,"2020-05-20 00:00:00,2019-03-08 00:00:00,2017-01-20 19:07:00,2016-01-23 09:00:00,2015-02-18 11:00:00,2015-01-27 11:00:00,2014-02-03 00:00:00,2013-02-13 10:20:00,2012-07-19 10:26:00,2012-07-16 00:00:00,2012-07-13 00:00:00,2011-02-28 12:20:00,2010-02-24 00:00:00,2009-04-23 00:00:00,2008-12-12 00:00:00,2008-02-27 00:00:00,2007-02-20 00:00:00,2005-02-21 00:00:00,2004-03-22 00:00:00,2003-03-03 00:00:00,2002-02-19 00:00:00,2001-05-04 00:00:00,2000-04-07 00:00:00,1999-02-23 00:00:00,1998-02-23 00:00:00,1996-03-28 00:00:00,1994-04-26 23:00:00",POINT (-82.4375 27.90625)
8662245,NITS1,Oyster Landing (N Inlet Estuary),SC,discontinued,"2022-06-07 00:00:00,2022-06-06 23:59:00,2015-12-08 00:00:00,2014-12-05 00:00:00,2013-12-18 00:00:00,2012-08-28 00:00:00,2011-11-04 00:00:00,2010-12-03 00:00:00,2009-12-11 00:00:00,2008-12-22 09:12:00,2008-12-08 00:00:00,2005-10-18 23:59:00,2005-10-18 00:00:00,2004-12-11 00:00:00,2003-11-21 23:59:00,2003-11-21 00:00:00,2002-12-07 00:00:00",POINT (-79.1875 33.34375)