Skip to content

Commit

Permalink
Set sphinx_rtd_theme for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@iuliivasilev
iuliivasilev committed May 9, 2024
1 parent a9c4011 commit 3372c30
Show file tree
Hide file tree
Showing 56 changed files with 5,529 additions and 3,164 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/static.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ jobs:
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
# - name: Install dependencies
# run: |
# pip install -r ./requirements/docs-requirements.txt
- name: Install dependencies
run: |
pip install -r ./requirements/docs-requirements.txt
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
Expand Down
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
View file
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: 74b915d5d3d3cbfd7a315d930ada4d89
config: a4521f06b2a4572007db91d4e50568ea
tags: 645f666f9bcd5a90fca523b33c5a78b7
210 changes: 112 additions & 98 deletions docs/_build/html/API Reference.html
View file
Original file line number Diff line number Diff line change
@@ -1,43 +1,103 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API Reference &mdash; survivors 1.6.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />

<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/" />

<title>API Reference &#8212; survivors 1.6.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<script src="_static/documentation_options.js?v=e15882dc"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<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=e15882dc"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Constants" href="modules/Constants.html" />
<link rel="prev" title="Component description" href="Component%20description.html" />

<link rel="stylesheet" href="_static/custom.css" type="text/css" />




<link rel="prev" title="Component description" href="Component%20description.html" />
</head>

</head><body>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<a href="index.html" class="icon icon-home">
survivors
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</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">Architecture</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Component%20description.html">Component description</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/Constants.html">Constants</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/Metrics.html">Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/Criteria.html">Criteria</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/Visualize.html">Visualize</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/External.html">External</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/Tree.html">Tree</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/Ensemble.html">Ensemble</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/Datasets.html">Datasets</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/Experiments.html">Experiments</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">About survivors</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="AboutSA.html">About survival analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="Why.html">Why survivors?</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="Citing.html">Citing survivors</a></li>
</ul>

<div class="body" role="main">

</div>
</div>
</nav>

<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">survivors</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">API Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/API Reference.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading"></a></h1>
<h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down Expand Up @@ -162,80 +222,34 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
</section>


</div>
</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">survivors</a></h1>








<h3>Navigation</h3>
<p class="caption" role="heading"><span class="caption-text">Architecture</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Component%20description.html">Component description</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">About survivors</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="AboutSA.html">About survival analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="Why.html">Why survivors?</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="Citing.html">Citing survivors</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="Component%20description.html" title="previous chapter">Component description</a></li>
<li>Next: <a href="modules/Constants.html" title="next chapter">Constants</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Component%20description.html" class="btn btn-neutral float-left" title="Component description" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="modules/Constants.html" class="btn btn-neutral float-right" title="Constants" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>





<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2024, Iulii Vasilev.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2024, Iulii Vasilev.

|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>

|
<a href="_sources/API Reference.rst.txt"
rel="nofollow">Page source</a>
</div>




</body>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit 3372c30

Please sign in to comment.