Skip to content

Commit e878083

Browse files
khiderkhider
authored
Merge pull request #14 from LinkedEarth/docs
Docs
2 parents e1c20cd + 0db7967 commit e878083

22 files changed

+307
-307
lines changed

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ Thumbs.db
2424
std-parser/
2525
test-pyleotups/
2626
nonstd-parser/
27-
/docs/build/**
27+
./docs/build/**

‎CITATION.cff‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
cff-version: 0.0.0.1
2+
message: "If you use this software, please cite it as below."
3+
authors:
4+
- family-names: "Oswal"
5+
given-names: "Dhiren"
6+
- family-names: "Khider"
7+
given-names: "Deborah"
8+
orcid: "https://orcid.org/0000-0001-7501-8430"
9+
- family-names: "Pujara"
10+
given-names: "Jay"
11+
orcid: "https://orcid.org/0000-0001-6921-1744"
12+
title: "PyleoTUPS: Automated Paleoclimate Data Extraction and Processing"
13+
version: v0.0.1
14+
date-released: 2025-07-18
15+
url: "https://github.com/LinkedEarth/PyleoTUPS"

‎docs/advanced.rst‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.. _advanced:
2+
3+
Advanced Functionalities
4+
========================
5+
6+
NOAADataset (pyleotups.utils.NOAADataset)
7+
"""""""""""""""""""""""""""""""""""""""""
8+
9+
.. automodule:: pyleotups.utils.NOAADataset
10+
:members:
11+
:ignore-module-all: True
12+
13+
14+
PaleoData (pyleotups.utils.PaleoData)
15+
"""""""""""""""""""""""""""""""""""""
16+
17+
.. automodule:: pyleotups.utils.PaleoData
18+
:members:
19+
:ignore-module-all: True
20+
21+
Publication (pyleotups.utils.Publication)
22+
""""""""""""""""""""""""""""""""""""""""""
23+
24+
.. automodule:: pyleotups.utils.Publication
25+
:members:
26+
:ignore-module-all: True
27+
28+
Site (pyleotups.utils.Site)
29+
""""""""""""""""""""""""""""""""""""""""""
30+
31+
.. automodule:: pyleotups.utils.Site
32+
:members:
33+
:ignore-module-all: True
34+
35+
36+
Parsers
37+
"""""""
38+
39+
NonStandardParser (pyleotups.utils.Parser.NonStandardParser)
40+
#############################################################
41+
42+
.. automodule:: pyleotups.utils.Parser.NonStandardParser
43+
:members:
44+
:ignore-module-all: True
45+
46+
47+
StandardParser (pyleotups.utils.Parser.StandardParser)
48+
######################################################
49+
50+
.. automodule:: pyleotups.utils.Parser.StandardParser
51+
:members:
52+
:ignore-module-all: True

‎docs/api.rst‎

Lines changed: 6 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,13 @@
11
.. _api:
22

3-
PyTUPS User API
4-
===============
3+
PyleoTUPS User APIs
4+
===================
55

6-
The following describes the main classes that make up PyTUPS.
6+
The following describes the main classes that make up PyleoTUPS.
77
Most users will primarily interact with the functionalities exposed in these classes.
88

9-
Core Components
10-
===============
9+
Dataset (pyleotups.core.Dataset.Dataset)
10+
""""""""""""""""""""""""""""""""""""""""
1111

12-
Dataset (pytups.core.Dataset.Dataset)
13-
""""""""""""""""""""""""""""""""""""""
14-
15-
.. autoclass:: pytups.core.Dataset.Dataset
16-
:members:
17-
:undoc-members:
18-
19-
20-
NOAADataset (pytups.core.NOAADataset.NOAADataset)
21-
"""""""""""""""""""""""""""""""""""""""""""""""""
22-
23-
.. autoclass:: pytups.core.NOAADataset.NOAADataset
24-
:members:
25-
:undoc-members:
26-
27-
28-
Utility Classes
29-
===============
30-
31-
PaleoData (pytups.utils.PaleoData.PaleoData)
32-
""""""""""""""""""""""""""""""""""""""""""""
33-
34-
.. autoclass:: pytups.utils.PaleoData.PaleoData
35-
:members:
36-
:undoc-members:
37-
38-
39-
Publication (pytups.utils.Publication.Publication)
40-
""""""""""""""""""""""""""""""""""""""""""""""""""
41-
42-
.. autoclass:: pytups.utils.Publication.Publication
43-
:members:
44-
:undoc-members:
45-
46-
47-
Site (pytups.utils.Site.Site)
48-
"""""""""""""""""""""""""""""
49-
50-
.. autoclass:: pytups.utils.Site.Site
51-
:members:
52-
:undoc-members:
53-
54-
55-
Parsers
56-
=======
57-
58-
StandardParser (pytups.utils.Parser.StandardParser.StandardParser)
59-
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
60-
61-
.. autoclass:: pytups.utils.Parser.StandardParser.StandardParser
12+
.. autoclass:: pyleotups.core.Dataset.Dataset
6213
:members:
63-
:undoc-members:

‎docs/citation.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.. _citing_PyleoTUPS:
2+
3+
Citing PyleoTUPS
4+
================
5+
6+
If PyleoTUPS played any role in your research, please add us to your reference list by using the citation below:
7+
8+
BibTeX entry
9+
"""""""""""""
10+
11+
For example (please check for version updates on Zenodo)
12+
13+
| @misc{PyleoTUPS,
14+
| year = {2025},
15+
| type = {Computer Program},
16+
| title = {PyleoTUPS: Automated Paleoclimate Data Extraction and Processing},
17+
| authors = {Dhiren Oswal and Deborah Khider and Jay Pujara}
18+
| }

‎docs/conf.py‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
# Now import pyleotups safely.
1212
import pyleotups as tups
1313

14-
project = 'pyleotups'
15-
copyright = '2025, Dhiren Oswal, Deborah Khider, Jay Pujara'
14+
project = 'PyleoTUPS'
15+
copyright = '2025, LinkedEarth'
1616
author = 'Dhiren Oswal, Deborah Khider, Jay Pujara'
1717
release = tups.__version__
1818
version = tups.__version__
@@ -36,7 +36,7 @@
3636
'nbsphinx',
3737
# 'IPython.sphinxext.ipython_console_highlighting',
3838
# 'IPython.sphinxext.ipython_directive',
39-
# 'sphinx_search.extension',
39+
'sphinx_search.extension',
4040
'jupyter_sphinx',
4141
'sphinx_copybutton'
4242
]
@@ -70,10 +70,15 @@
7070

7171
html_theme = 'sphinx_rtd_theme'
7272

73+
source_suffix = '.rst'
74+
7375
htmlhelp_basename = 'pyleotupsdoc'
74-
html_static_path = ['_static']
75-
master_doc = 'index'
76-
# man_pages = [
77-
# (master_doc, 'pyleoclim', 'Pyleoclim Documentation',
78-
# [author], 1)
79-
# ]
76+
#html_static_path = ['_static']
77+
78+
exclude_patterns = ['build']
79+
80+
# The name of the Pygments (syntax highlighting) style to use.
81+
pygments_style = 'sphinx'
82+
83+
#Logo
84+
html_logo = 'pyleotups_logo_small.png'

0 commit comments

Comments
 (0)