PicassoPy/pyproject.toml at main · PollyNET/PicassoPy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

[build-system]
requires = ["setuptools>=61.0", "wheel",
            ]
build-backend = "setuptools.build_meta"


[project]
name = "PicassoPy"
version = "0.1.1"
authors = [
  { name="Andi Klamt", email="klamt@tropos.de" },
  { name="Martin Radenz", email="radenz@tropos.de" },
  { name="Håvard Buholdt", email="buholdt@tropos.de" },
]
description='Data cube for handling atmospheric observations of profiling remote sensing instruments.'
requires-python = ">=3.8"
license = {text = "MIT License"}
classifiers = [
  'Development Status :: 1 - Planning',
  'Intended Audience :: Science/Research',
  'License :: OSI Approved :: BSD License',
  'Operating System :: POSIX :: Linux',
  'Programming Language :: Python :: 3',
  'Programming Language :: Python :: 3.8',
]
readme = 'README.md'
dependencies = [
  "numpy",
  "scipy",
  "netCDF4",
  "xarray",
  "pandas",
  "openpyxl", # might be an optional dependency
  "GitPython",
  "matplotlib",
]

[tool.setuptools.packages]
find = {}

[project.optional-dependencies]
doc = [
  "sphinx",
  "pydata_sphinx_theme",
]


[tool.sphinx-pyproject]
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
project = "PicassoPy" # for some reason the project name has to be repeated here
coverage_show_missing_items = true
extensions = [
  #"autoapi.extension", not quite sure yet if to use autoapi, apidoc or autodoc...
  "sphinx.ext.autodoc",
  #"sphinx_autodoc_typehints",
  "sphinx.ext.viewcode",
  "sphinx.ext.coverage",
  "sphinx.ext.mathjax",
  "sphinx.ext.viewcode",
  "sphinx.ext.todo",
  "numpydoc",
  "myst_parser"
  #"sphinx.ext.autosectionlabel",
  #"recommonmark",
]
sphinx_rtd_size_width = "90%"
source_suffix = {'.rst' = 'restructuredtext', '.md' = 'markdown'}
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
auto_doc_default_options = {'autosummary' = true}
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "pydata_sphinx_theme"
#html_style = "css/custom.css"
html_static_path = ["_static"]
#html_theme_options = {'sticky_navigation' = true, 'includehidden' = true, 'titles_only' = false}
html_theme_options = {"external_links"= [{"name" = "PollyNET", "url" = "https://polly.tropos.de/"}]}
autoclass_content = "both"
todo_include_todos = true
numpydoc_show_class_members = false # no method names in class overview for now (https://stackoverflow.com/questions/65198998/sphinx-warning-autosummary-stub-file-not-found-for-the-methods-of-the-class-c)

[tool.sphinx-pyproject.autodoc_default_options]
# exclude-members = """
#   __weakref__,
#   __sizeof__,
#   __hash__,
#   __module__,
#   __dict__,
#   __annotations__,
#   __orig_bases__,
#   __parameters__,
#   __abstractmethods__,
#   __non_callable_proto_members__,
#   __protocol_attrs__,
#   __subclasshook__,
#   __dataclass_fields__,
#   __post_init__,
#   __dataclass_params__,
#   __match_args__,
#   __str__,
#   __repr__"""
members = true
member-order = 'bysource'
# special-members = true
undoc-members = false