Skip to content

Commit a191eff

Browse files
jvsguerrajvsguerra
committed
Update documentation
1 parent 860a387 commit a191eff

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+21981
-0
lines changed

‎docs/.buildinfo

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: a8e686330cd82d1e1e428ef58223c494
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/.doctrees/_about/index.doctree

9 KB
Binary file not shown.

‎docs/.doctrees/_api_reference/index.doctree

199 KB
Binary file not shown.

‎docs/.doctrees/_installation/index.doctree

6.57 KB
Binary file not shown.

‎docs/.doctrees/_tutorial/index.doctree

64.1 KB
Binary file not shown.

‎docs/.doctrees/index.doctree

4.39 KB
Binary file not shown.

‎docs/.nojekyll

Whitespace-only changes.

‎docs/_about/index.html

+161
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" >
3+
<head>
4+
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
5+
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Issues &mdash; SERD 0.1.1 documentation</title>
8+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
9+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
10+
<link rel="shortcut icon" href="../_static/icon.ico"/>
11+
<!--[if lt IE 9]>
12+
<script src="../_static/js/html5shiv.min.js"></script>
13+
<![endif]-->
14+
15+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
16+
<script src="../_static/jquery.js"></script>
17+
<script src="../_static/underscore.js"></script>
18+
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
19+
<script src="../_static/doctools.js"></script>
20+
<script src="../_static/js/theme.js"></script>
21+
<link rel="index" title="Index" href="../genindex.html" />
22+
<link rel="search" title="Search" href="../search.html" />
23+
<link rel="prev" title="SERD.detect" href="../_api_reference/index.html" />
24+
</head>
25+
26+
<body class="wy-body-for-nav">
27+
<div class="wy-grid-for-nav">
28+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
29+
<div class="wy-side-scroll">
30+
<div class="wy-side-nav-search" >
31+
<a href="../index.html" class="icon icon-home"> SERD
32+
</a>
33+
<div class="version">
34+
0.1
35+
</div>
36+
<div role="search">
37+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
38+
<input type="text" name="q" placeholder="Search docs" />
39+
<input type="hidden" name="check_keywords" value="yes" />
40+
<input type="hidden" name="area" value="default" />
41+
</form>
42+
</div>
43+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
44+
<p class="caption" role="heading"><span class="caption-text">Installation</span></p>
45+
<ul>
46+
<li class="toctree-l1"><a class="reference internal" href="../_installation/index.html">Requirements</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="../_installation/index.html#installation">Installation</a></li>
48+
</ul>
49+
<p class="caption" role="heading"><span class="caption-text">Tutorial</span></p>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../_tutorial/index.html">Tutorial</a></li>
52+
</ul>
53+
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
54+
<ul>
55+
<li class="toctree-l1"><a class="reference internal" href="../_api_reference/index.html">SERD.detect</a></li>
56+
<li class="toctree-l1"><a class="reference internal" href="../_api_reference/index.html#serd-g2pdb">SERD.g2pdb</a></li>
57+
<li class="toctree-l1"><a class="reference internal" href="../_api_reference/index.html#serd-get-vertices">SERD.get_vertices</a></li>
58+
<li class="toctree-l1"><a class="reference internal" href="../_api_reference/index.html#serd-interface">SERD.interface</a></li>
59+
<li class="toctree-l1"><a class="reference internal" href="../_api_reference/index.html#serd-r2g">SERD.r2g</a></li>
60+
<li class="toctree-l1"><a class="reference internal" href="../_api_reference/index.html#serd-read-vdw">SERD.read_vdw</a></li>
61+
<li class="toctree-l1"><a class="reference internal" href="../_api_reference/index.html#serd-read-pdb">SERD.read_pdb</a></li>
62+
<li class="toctree-l1"><a class="reference internal" href="../_api_reference/index.html#serd-save">SERD.save</a></li>
63+
<li class="toctree-l1"><a class="reference internal" href="../_api_reference/index.html#serd-save-session">SERD.save_session</a></li>
64+
<li class="toctree-l1"><a class="reference internal" href="../_api_reference/index.html#serd-surface">SERD.surface</a></li>
65+
</ul>
66+
<p class="caption" role="heading"><span class="caption-text">About</span></p>
67+
<ul class="current">
68+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Issues</a><ul>
69+
<li class="toctree-l2"><a class="reference external" href="https://github.com/jvsguerra/SERD/issues/new?assignees=&amp;labels=&amp;template=bug_report.md&amp;title=">Bug Report</a></li>
70+
<li class="toctree-l2"><a class="reference external" href="https://github.com/jvsguerra/SERD/issues/new?assignees=&amp;labels=&amp;template=feature_request.md&amp;title=">Request for a new feature</a></li>
71+
</ul>
72+
</li>
73+
<li class="toctree-l1"><a class="reference internal" href="#scientific-team">Scientific team</a></li>
74+
<li class="toctree-l1"><a class="reference internal" href="#license">License</a></li>
75+
</ul>
76+
77+
</div>
78+
</div>
79+
</nav>
80+
81+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
82+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
83+
<a href="../index.html">SERD</a>
84+
</nav>
85+
86+
<div class="wy-nav-content">
87+
<div class="rst-content">
88+
<div role="navigation" aria-label="Page navigation">
89+
<ul class="wy-breadcrumbs">
90+
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
91+
<li>Issues</li>
92+
<li class="wy-breadcrumbs-aside">
93+
<a href="../_sources/_about/index.rst.txt" rel="nofollow"> View page source</a>
94+
</li>
95+
</ul>
96+
<hr/>
97+
</div>
98+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
99+
<div itemprop="articleBody">
100+
101+
<h1>About</h1><section id="issues">
102+
<h1>Issues<a class="headerlink" href="#issues" title="Permalink to this heading"></a></h1>
103+
<p>SERD package uses of GitHub for project management. Please help us by reporting any problems or requests.</p>
104+
<p>On <a class="reference external" href="https://github.com/jvsguerra/SERD/issues">Issues</a> page, you can file a:</p>
105+
<div class="toctree-wrapper compound">
106+
<ul>
107+
<li class="toctree-l1"><a class="reference external" href="https://github.com/jvsguerra/SERD/issues/new?assignees=&amp;labels=&amp;template=bug_report.md&amp;title=">Bug Report</a></li>
108+
<li class="toctree-l1"><a class="reference external" href="https://github.com/jvsguerra/SERD/issues/new?assignees=&amp;labels=&amp;template=feature_request.md&amp;title=">Request for a new feature</a></li>
109+
</ul>
110+
</div>
111+
<p>Only make sure the bug or request has not already been reported. Click on “Search” and enter some keywords to search.</p>
112+
<p>Thank you for helping us improve SERD!</p>
113+
</section>
114+
<section id="scientific-team">
115+
<h1>Scientific team<a class="headerlink" href="#scientific-team" title="Permalink to this heading"></a></h1>
116+
<p>SERD was developed by:</p>
117+
<ul class="simple">
118+
<li><p>João Victor da Silva Guerra</p></li>
119+
<li><p>Gabriel Ernesto Jara</p></li>
120+
<li><p>José Geraldo de Carvalho Pereira</p></li>
121+
<li><p>Paulo Sergio Lopes de Oliveira</p></li>
122+
</ul>
123+
<p>Computational Biology Laboratory (<a class="reference external" href="https://github.com/LBC-LNBio">LBC</a>), Brazilian Biosciences National Laboratory (<a class="reference external" href="https://lnbio.cnpem.br/">LNBio</a>), Brazilian Center for Research in Energy and Materials (<a class="reference external" href="https://cnpem.br">CNPEM</a>)</p>
124+
<p>If you have any further questions, inquires or if you wish to contribute to SERD, please contact us at <a class="reference external" href="mailto:jvsguerra&#37;&#52;&#48;gmail&#46;com">jvsguerra<span>&#64;</span>gmail<span>&#46;</span>com</a>.</p>
125+
</section>
126+
<section id="license">
127+
<h1>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h1>
128+
<p>The software is licensed under the terms of the GNU General Public License version 3 (GPL3) and is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
129+
</section>
130+
131+
132+
</div>
133+
</div>
134+
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
135+
<a href="../_api_reference/index.html" class="btn btn-neutral float-left" title="SERD.detect" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
136+
</div>
137+
138+
<hr/>
139+
140+
<div role="contentinfo">
141+
<p>&#169; Copyright 2022, João Victor da Silva Guerra.</p>
142+
</div>
143+
144+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
145+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
146+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
147+
148+
149+
</footer>
150+
</div>
151+
</div>
152+
</section>
153+
</div>
154+
<script>
155+
jQuery(function () {
156+
SphinxRtdTheme.Navigation.enable(true);
157+
});
158+
</script>
159+
160+
</body>
161+
</html>

0 commit comments

Comments
 (0)