Skip to content

Commit 7a0e393

Browse files
ajgates42ajgates42
committed
doc format
1 parent 0843c68 commit 7a0e393

File tree

17 files changed

+551
-612
lines changed

17 files changed

+551
-612
lines changed

‎docs/clusim.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
sphinx-quickstart on Thu Aug 23 00:00:27 2018.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
5-
:orphan:
65
76
Welcome to CluSim's documentation!
87

‎docs/conf.py‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
source_suffix = '.rst'
5656

5757
# The master toctree document.
58-
master_doc = 'y'
58+
master_doc = 'clusim'
5959

6060
# General information about the project.
6161
project = u'clusim'
@@ -94,22 +94,23 @@
9494
# a list of builtin themes.
9595
#
9696
#html_theme = 'alabaster'
97-
import guzzle_sphinx_theme
97+
#import guzzle_sphinx_theme
9898

99-
html_theme_path = guzzle_sphinx_theme.html_theme_path()
100-
html_theme = 'guzzle_sphinx_theme'
99+
#html_theme_path = guzzle_sphinx_theme.html_theme_path()
100+
#html_theme = 'guzzle_sphinx_theme'
101+
html_theme = 'nature'
101102

102103
# Register the theme as an extension to generate a sitemap.xml
103-
extensions.append("guzzle_sphinx_theme")
104+
#extensions.append("guzzle_sphinx_theme")
104105

105106
# Guzzle theme options (see theme.conf for more information)
106-
html_theme_options = {
107+
#html_theme_options = {
107108
# Set the name of the project to appear in the sidebar
108-
"project_nav_name": "CluSim",
109+
# "project_nav_name": "CluSim",
109110

110111
# Set you GA account ID to enable tracking
111112
#"google_analytics_account": "my_ga_account",
112-
}
113+
#}
113114

114115
# Theme options are theme-specific and customize the look and feel of a theme
115116
# further. For a list of options available for each theme, see the

‎docs/html/_modules/clusim/clugen.html‎

Lines changed: 29 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,16 @@
44
<html>
55
<head>
66
<meta charset="utf-8" />
7-
8-
<!-- Licensed under the Apache 2.0 License -->
9-
<link rel="stylesheet" type="text/css" href="../../_static/fonts/open-sans/stylesheet.css" />
10-
<!-- Licensed under the SIL Open Font License -->
11-
<link rel="stylesheet" type="text/css" href="../../_static/fonts/source-serif-pro/source-serif-pro.css" />
12-
<link rel="stylesheet" type="text/css" href="../../_static/css/bootstrap.min.css" />
13-
<link rel="stylesheet" type="text/css" href="../../_static/css/bootstrap-theme.min.css" />
14-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
15-
167
<title>clusim.clugen &#8212; clusim 0.4 documentation</title>
17-
<link rel="stylesheet" href="../../_static/guzzle.css" type="text/css" />
8+
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
189
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1910
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
2011
<script src="../../_static/jquery.js"></script>
2112
<script src="../../_static/underscore.js"></script>
2213
<script src="../../_static/doctools.js"></script>
2314
<script src="../../_static/language_data.js"></script>
2415
<link rel="index" title="Index" href="../../genindex.html" />
25-
<link rel="search" title="Search" href="../../search.html" />
26-
27-
28-
16+
<link rel="search" title="Search" href="../../search.html" />
2917
</head><body>
3018
<div class="related" role="navigation" aria-label="related navigation">
3119
<h3>Navigation</h3>
@@ -36,46 +24,15 @@ <h3>Navigation</h3>
3624
<li class="right" >
3725
<a href="../../py-modindex.html" title="Python Module Index"
3826
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../y.html">clusim 0.4 documentation</a> &#187;</li>
27+
<li class="nav-item nav-item-0"><a href="../../clusim.html">clusim 0.4 documentation</a> &#187;</li>
4028
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
4129
</ul>
42-
</div>
43-
<div class="container-wrapper">
30+
</div>
4431

45-
<div id="mobile-toggle">
46-
<a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
47-
</div>
48-
<div id="left-column">
49-
<div class="sphinxsidebar">
50-
<div class="sidebar-block">
51-
<div class="sidebar-wrapper">
52-
<div id="main-search">
53-
<form class="form-inline" action="../../search.html" method="GET" role="form">
54-
<div class="input-group">
55-
<input name="q" type="text" class="form-control" placeholder="Search...">
56-
</div>
57-
<input type="hidden" name="check_keywords" value="yes" />
58-
<input type="hidden" name="area" value="default" />
59-
</form>
60-
</div>
61-
</div>
62-
</div>
63-
64-
</div>
65-
</div>
66-
<div id="right-column">
67-
68-
<div role="navigation" aria-label="breadcrumbs navigation">
69-
<ol class="breadcrumb">
70-
<li><a href="../../y.html">Docs</a></li>
71-
72-
<li><a href="../index.html">Module code</a></li>
73-
74-
<li>clusim.clugen</li>
75-
</ol>
76-
</div>
77-
78-
<div class="document clearer body">
32+
<div class="document">
33+
<div class="documentwrapper">
34+
<div class="bodywrapper">
35+
<div class="body" role="main">
7936

8037
<h1>Source code for clusim.clugen</h1><div class="highlight"><pre>
8138
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
@@ -547,9 +504,23 @@ <h1>Source code for clusim.clugen</h1><div class="highlight"><pre>
547504
</pre></div>
548505

549506
</div>
550-
551507
</div>
552-
<div class="clearfix"></div>
508+
</div>
509+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
510+
<div class="sphinxsidebarwrapper">
511+
<div id="searchbox" style="display: none" role="search">
512+
<h3 id="searchlabel">Quick search</h3>
513+
<div class="searchformwrapper">
514+
<form class="search" action="../../search.html" method="get">
515+
<input type="text" name="q" aria-labelledby="searchlabel" />
516+
<input type="submit" value="Go" />
517+
</form>
518+
</div>
519+
</div>
520+
<script>$('#searchbox').show(0);</script>
521+
</div>
522+
</div>
523+
<div class="clearer"></div>
553524
</div>
554525
<div class="related" role="navigation" aria-label="related navigation">
555526
<h3>Navigation</h3>
@@ -560,18 +531,13 @@ <h3>Navigation</h3>
560531
<li class="right" >
561532
<a href="../../py-modindex.html" title="Python Module Index"
562533
>modules</a> |</li>
563-
<li class="nav-item nav-item-0"><a href="../../y.html">clusim 0.4 documentation</a> &#187;</li>
534+
<li class="nav-item nav-item-0"><a href="../../clusim.html">clusim 0.4 documentation</a> &#187;</li>
564535
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
565536
</ul>
566537
</div>
567-
<script type="text/javascript">
568-
$("#mobile-toggle a").click(function () {
569-
$("#left-column").toggle();
570-
});
571-
</script>
572-
<script type="text/javascript" src="../../_static/js/bootstrap.js"></script>
573-
<div class="footer">
574-
&copy; Copyright 2017, Alexander Gates and Yong-Yeol Ahn. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
575-
</div>
538+
<div class="footer" role="contentinfo">
539+
&#169; Copyright 2017, Alexander Gates and Yong-Yeol Ahn.
540+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.3.
541+
</div>
576542
</body>
577543
</html>

‎docs/html/_modules/clusim/clusimelement.html‎

Lines changed: 29 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,16 @@
44
<html>
55
<head>
66
<meta charset="utf-8" />
7-
8-
<!-- Licensed under the Apache 2.0 License -->
9-
<link rel="stylesheet" type="text/css" href="../../_static/fonts/open-sans/stylesheet.css" />
10-
<!-- Licensed under the SIL Open Font License -->
11-
<link rel="stylesheet" type="text/css" href="../../_static/fonts/source-serif-pro/source-serif-pro.css" />
12-
<link rel="stylesheet" type="text/css" href="../../_static/css/bootstrap.min.css" />
13-
<link rel="stylesheet" type="text/css" href="../../_static/css/bootstrap-theme.min.css" />
14-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
15-
167
<title>clusim.clusimelement &#8212; clusim 0.4 documentation</title>
17-
<link rel="stylesheet" href="../../_static/guzzle.css" type="text/css" />
8+
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
189
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1910
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
2011
<script src="../../_static/jquery.js"></script>
2112
<script src="../../_static/underscore.js"></script>
2213
<script src="../../_static/doctools.js"></script>
2314
<script src="../../_static/language_data.js"></script>
2415
<link rel="index" title="Index" href="../../genindex.html" />
25-
<link rel="search" title="Search" href="../../search.html" />
26-
27-
28-
16+
<link rel="search" title="Search" href="../../search.html" />
2917
</head><body>
3018
<div class="related" role="navigation" aria-label="related navigation">
3119
<h3>Navigation</h3>
@@ -36,46 +24,15 @@ <h3>Navigation</h3>
3624
<li class="right" >
3725
<a href="../../py-modindex.html" title="Python Module Index"
3826
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../y.html">clusim 0.4 documentation</a> &#187;</li>
27+
<li class="nav-item nav-item-0"><a href="../../clusim.html">clusim 0.4 documentation</a> &#187;</li>
4028
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
4129
</ul>
42-
</div>
43-
<div class="container-wrapper">
30+
</div>
4431

45-
<div id="mobile-toggle">
46-
<a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
47-
</div>
48-
<div id="left-column">
49-
<div class="sphinxsidebar">
50-
<div class="sidebar-block">
51-
<div class="sidebar-wrapper">
52-
<div id="main-search">
53-
<form class="form-inline" action="../../search.html" method="GET" role="form">
54-
<div class="input-group">
55-
<input name="q" type="text" class="form-control" placeholder="Search...">
56-
</div>
57-
<input type="hidden" name="check_keywords" value="yes" />
58-
<input type="hidden" name="area" value="default" />
59-
</form>
60-
</div>
61-
</div>
62-
</div>
63-
64-
</div>
65-
</div>
66-
<div id="right-column">
67-
68-
<div role="navigation" aria-label="breadcrumbs navigation">
69-
<ol class="breadcrumb">
70-
<li><a href="../../y.html">Docs</a></li>
71-
72-
<li><a href="../index.html">Module code</a></li>
73-
74-
<li>clusim.clusimelement</li>
75-
</ol>
76-
</div>
77-
78-
<div class="document clearer body">
32+
<div class="document">
33+
<div class="documentwrapper">
34+
<div class="bodywrapper">
35+
<div class="body" role="main">
7936

8037
<h1>Source code for clusim.clusimelement</h1><div class="highlight"><pre>
8138
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
@@ -573,9 +530,23 @@ <h1>Source code for clusim.clusimelement</h1><div class="highlight"><pre>
573530
</pre></div>
574531

575532
</div>
576-
577533
</div>
578-
<div class="clearfix"></div>
534+
</div>
535+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
536+
<div class="sphinxsidebarwrapper">
537+
<div id="searchbox" style="display: none" role="search">
538+
<h3 id="searchlabel">Quick search</h3>
539+
<div class="searchformwrapper">
540+
<form class="search" action="../../search.html" method="get">
541+
<input type="text" name="q" aria-labelledby="searchlabel" />
542+
<input type="submit" value="Go" />
543+
</form>
544+
</div>
545+
</div>
546+
<script>$('#searchbox').show(0);</script>
547+
</div>
548+
</div>
549+
<div class="clearer"></div>
579550
</div>
580551
<div class="related" role="navigation" aria-label="related navigation">
581552
<h3>Navigation</h3>
@@ -586,18 +557,13 @@ <h3>Navigation</h3>
586557
<li class="right" >
587558
<a href="../../py-modindex.html" title="Python Module Index"
588559
>modules</a> |</li>
589-
<li class="nav-item nav-item-0"><a href="../../y.html">clusim 0.4 documentation</a> &#187;</li>
560+
<li class="nav-item nav-item-0"><a href="../../clusim.html">clusim 0.4 documentation</a> &#187;</li>
590561
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
591562
</ul>
592563
</div>
593-
<script type="text/javascript">
594-
$("#mobile-toggle a").click(function () {
595-
$("#left-column").toggle();
596-
});
597-
</script>
598-
<script type="text/javascript" src="../../_static/js/bootstrap.js"></script>
599-
<div class="footer">
600-
&copy; Copyright 2017, Alexander Gates and Yong-Yeol Ahn. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
601-
</div>
564+
<div class="footer" role="contentinfo">
565+
&#169; Copyright 2017, Alexander Gates and Yong-Yeol Ahn.
566+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.3.
567+
</div>
602568
</body>
603569
</html>

0 commit comments

Comments
 (0)