Skip to content

NonStandard Parser documentation compilation #25

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

Merged
khider merged 4 commits into from
Nov 4, 2025
Merged

NonStandard Parser documentation compilation #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7e63078
Update NonStandardParser
Nov 4, 2025
38e90dc
Adding tests for NonStandardParser
Nov 4, 2025
bc6a7b3
Compiling documentation of NonStandardParser
Nov 4, 2025
a500687
Compiling documentation of NonStandardParser form root
Nov 4, 2025
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
20 changes: 13 additions & 7 deletions docs/advanced.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,23 @@ Site (pyleotups.utils.Site)
Parsers
"""""""

StandardParser (pyleotups.utils.Parser.StandardParser)
######################################################

.. autoclass:: pyleotups.utils.Parser.StandardParser
:members:


NonStandardParser (pyleotups.utils.Parser.NonStandardParser)
#############################################################

.. automodule:: pyleotups.utils.Parser.NonStandardParser
.. autoclass:: pyleotups.utils.Parser.NonStandardParser
:members:
:ignore-module-all: True


NonStandardParserUtils (pyleotups.utils.Parser.NonStandardParserUtils)
#######################################################################

StandardParser (pyleotups.utils.Parser.StandardParser)
######################################################

.. automodule:: pyleotups.utils.Parser.StandardParser
.. automodule:: pyleotups.utils.Parser.NonStandardParserUtils
:members:
:ignore-module-all: True
:ignore-module-all: True
Binary file added docs/build/doctrees/advanced.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/api.doctree
View file
Open in desktop
Binary file not shown.
Binary file added docs/build/doctrees/citation.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/contribution_guide.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/installation.doctree
View file
Open in desktop
Binary file not shown.
Binary file added docs/build/doctrees/tutorials.doctree
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d95b1a004effa6071004b083f1153191
config: f3695f8aeb771be480c51c2ced288d89
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 4 additions & 0 deletions docs/build/html/.buildinfo.bak
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d95b1a004effa6071004b083f1153191
tags: 645f666f9bcd5a90fca523b33c5a78b7
53 changes: 31 additions & 22 deletions docs/build/html/_modules/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,27 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; PyTUPS 0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<title>Overview: module code &mdash; PyleoTUPS 0.0.2b0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/jupyter-sphinx.css" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css?v=7f9a90b1" />
<link rel="stylesheet" type="text/css" href="../_static/jupyter-sphinx.css?v=572af1d6" />
<link rel="stylesheet" type="text/css" href="../_static/thebelab.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />


<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=d45e8c67"></script>
<script src="../_static/documentation_options.js?v=5e47b899"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/thebelab-helper.js"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=f281be69"></script>
<script src="../_static/js/rtd_search_config.js?v=b0596c34"></script>
<script src="../_static/js/rtd_sphinx_search.min.js?v=5e065386"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand All @@ -39,7 +43,8 @@


<a href="../index.html" class="icon icon-home">
PyTUPS
PyleoTUPS
<img src="../_static/pyleotups_logo_small.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand All @@ -49,17 +54,20 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Working with PyTUPS</span></p>
<p class="caption" role="heading"><span class="caption-text">Working with PyleoTUPS</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installing PyTUPS</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html">PyTUPS User API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html#core-components">Core Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html#utility-classes">Utility Classes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html#parsers">Parsers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installing PyleoTUPS</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html">PyleoTUPS User APIs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Advanced Functions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../advanced.html">Advanced Functionalities</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Getting Involved</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../contribution_guide.html">Contributing to PyTUPS</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contribution_guide.html">Contributing to PyleoTUPS</a></li>
<li class="toctree-l1"><a class="reference internal" href="../citation.html">Citing PyleoTUPS</a></li>
</ul>

</div>
Expand All @@ -68,7 +76,7 @@

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">PyTUPS</a>
<a href="../index.html">PyleoTUPS</a>
</nav>

<div class="wy-nav-content">
Expand All @@ -86,13 +94,14 @@
<div itemprop="articleBody">

<h1>All modules for which code is available</h1>
<ul><li><a href="pytups/core/Dataset.html">pytups.core.Dataset</a></li>
<li><a href="pytups/core/NOAADataset.html">pytups.core.NOAADataset</a></li>
<li><a href="pytups/utils/PaleoData.html">pytups.utils.PaleoData</a></li>
<li><a href="pytups/utils/Parser/StandardParser.html">pytups.utils.Parser.StandardParser</a></li>
<li><a href="pytups/utils/Publication.html">pytups.utils.Publication</a></li>
<li><a href="pytups/utils/Site.html">pytups.utils.Site</a></li>
<li><a href="pytups/utils/helpers.html">pytups.utils.helpers</a></li>
<ul><li><a href="pyleotups/core/Dataset.html">pyleotups.core.Dataset</a></li>
<li><a href="pyleotups/utils/NOAADataset.html">pyleotups.utils.NOAADataset</a></li>
<li><a href="pyleotups/utils/PaleoData.html">pyleotups.utils.PaleoData</a></li>
<li><a href="pyleotups/utils/Parser/NonStandardParser.html">pyleotups.utils.Parser.NonStandardParser</a></li>
<li><a href="pyleotups/utils/Parser/NonStandardParserUtils.html">pyleotups.utils.Parser.NonStandardParserUtils</a></li>
<li><a href="pyleotups/utils/Parser/StandardParser.html">pyleotups.utils.Parser.StandardParser</a></li>
<li><a href="pyleotups/utils/Publication.html">pyleotups.utils.Publication</a></li>
<li><a href="pyleotups/utils/Site.html">pyleotups.utils.Site</a></li>
</ul>

</div>
Expand All @@ -102,7 +111,7 @@ <h1>All modules for which code is available</h1>
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2025, Dhiren Oswal, Deborah Khider, Jay Pujara.</p>
<p>&#169; Copyright 2025, LinkedEarth.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
Loading
Loading