Skip to content

updated the python api documentation with sphinx #1077

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
merged 2 commits into from
Jul 24, 2024
Merged

updated the python api documentation with sphinx #1077

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
a64bbf1
updated the python api documentation with sphinx
chakravarthik27 Jul 24, 2024
b0ec59b
version changed from 1.1.0 to 2.3.1
chakravarthik27 Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion docs/api/.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 hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 94de02aa293eb54ef11a5bc3e2b36452
config: 1d8a75a4e16abdf0144a1c2d906d4ecb
tags: 645f666f9bcd5a90fca523b33c5a78b7
126 changes: 74 additions & 52 deletions docs/api/api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
<!DOCTYPE html>


<html lang="en" >
<html lang="en" data-content_root="" >

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>&lt;no title&gt; &#8212; langtest 1.1.0 documentation</title>
<title>&lt;no title&gt; &#8212; langtest 2.3.1 documentation</title>



Expand All @@ -19,12 +19,12 @@
</script>

<!-- Loaded before other Sphinx assets -->
<link href="static/styles/theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="static/styles/theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="static/styles/bootstrap.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link href="static/styles/pydata-sphinx-theme.css?digest=5b4479735964841361fd" rel="stylesheet" />


<link href="static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="static/vendor/fontawesome/6.1.2/css/all.min.css?digest=5b4479735964841361fd" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
Expand All @@ -33,8 +33,9 @@
<link rel="stylesheet" type="text/css" href="static/css/custom.css" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="static/scripts/bootstrap.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="static/scripts/bootstrap.js?digest=5b4479735964841361fd" />
<link rel="preload" as="script" href="static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
<script src="static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>

<script data-url_root="./" id="documentation_options" src="static/documentation_options.js"></script>
<script src="static/doctools.js"></script>
Expand All @@ -54,6 +55,15 @@

<a class="skip-link" href="#main-content">Skip to main content</a>

<div id="pst-scroll-pixel-helper"></div>


<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>
Back to top
</button>


<input type="checkbox"
class="sidebar-toggle"
name="__primary"
Expand Down Expand Up @@ -93,35 +103,38 @@
<span class="fa-solid fa-bars"></span>
</label>

<div class="navbar-header-items__start">

<div class="col-lg-3 navbar-header-items__start">

<div class="navbar-item">



<a class="navbar-brand logo" href="index.html">










<img src="static/logo.png" class="logo__image only-light" alt="Logo image"/>
<script>document.write(`<img src="static/logo.png" class="logo__image only-dark" alt="Logo image"/>`);</script>
<img src="static/logo.png" class="logo__image only-light" alt="langtest 2.3.1 documentation - Home"/>
<script>document.write(`<img src="static/logo.png" class="logo__image only-dark" alt="langtest 2.3.1 documentation - Home"/>`);</script>


</a></div>

</div>


<div class="col-lg-9 navbar-header-items">

<div class="me-auto navbar-header-items__center">

<div class="navbar-item"><nav class="navbar-nav">
<div class="navbar-item">
<nav class="navbar-nav">
<p class="sidebar-header-items__title"
role="heading"
aria-level="1"
Expand Down Expand Up @@ -153,23 +166,27 @@

<div class="navbar-item navbar-persistent--container">

<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">

<script>
document.write(`
<button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
</div>


<div class="navbar-item">

<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
<button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
</button>
`);
</script></div>
Expand All @@ -185,8 +202,8 @@



<a href="https://github.com/JohnSnowLabs/langtest" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github"></i></span>
<label class="sr-only">GitHub</label></a>
<a href="https://github.com/JohnSnowLabs/langtest" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>

Expand All @@ -196,13 +213,16 @@


<div class="navbar-persistent--mobile">
<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">

<script>
document.write(`
<button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
</div>


Expand All @@ -223,7 +243,8 @@

<div class="sidebar-header-items__center">

<div class="navbar-item"><nav class="navbar-nav">
<div class="navbar-item">
<nav class="navbar-nav">
<p class="sidebar-header-items__title"
role="heading"
aria-level="1"
Expand Down Expand Up @@ -255,12 +276,13 @@
<div class="sidebar-header-items__end">

<div class="navbar-item">

<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
<button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
</button>
`);
</script></div>
Expand All @@ -276,8 +298,8 @@



<a href="https://github.com/JohnSnowLabs/langtest" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github"></i></span>
<label class="sr-only">GitHub</label></a>
<a href="https://github.com/JohnSnowLabs/langtest" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>

Expand Down Expand Up @@ -309,8 +331,8 @@



<nav aria-label="Breadcrumbs">
<ul class="bd-breadcrumbs" role="navigation" aria-label="Breadcrumb">
<nav aria-label="Breadcrumb">
<ul class="bd-breadcrumbs">

<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
Expand Down Expand Up @@ -347,16 +369,12 @@



<footer class="bd-footer-article">


<footer class="prev-next-footer">

<div class="footer-article-items footer-article__inner">

<div class="footer-article-item"><!-- Previous / next buttons -->
<div class="prev-next-area">
</div></div>

</div>

</footer>

</div>
Expand All @@ -374,15 +392,16 @@
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="static/scripts/bootstrap.js?digest=e353d410970836974a52"></script>
<script src="static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></script>
<script src="static/scripts/bootstrap.js?digest=5b4479735964841361fd"></script>
<script src="static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd"></script>

<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">

<div class="footer-items__start">

<div class="footer-item">

<p class="copyright">

© Copyright 2023, John Snow Labs.
Expand All @@ -392,6 +411,7 @@
</div>

<div class="footer-item">

<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.1.3.
<br/>
Expand All @@ -401,10 +421,12 @@
</div>



<div class="footer-items__end">

<div class="footer-item"><p class="theme-version">
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.13.3.
<div class="footer-item">
<p class="theme-version">
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.14.4.
</p></div>

</div>
Expand Down
Loading