Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 10, 2023
1 parent ba97c30 commit 7ccb1f6
Show file tree
Hide file tree
Showing 9 changed files with 160 additions and 23 deletions.
12 changes: 6 additions & 6 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
.. No Errors Test Project documentation master file, created by
sphinx-quickstart on Fri Aug 30 17:07:56 2019.
.. package_name documentation master file, created by
sphinx-quickstart on Tue Aug 6 16:58:44 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to No Errors Test Project's documentation!
==================================================
Welcome to package_name's documentation!
========================================

.. toctree::
:maxdepth: 2
:caption: Hello World!

:caption: Contents:

reference

Indices and tables
==================
Expand Down
9 changes: 9 additions & 0 deletions _sources/reference.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
=============
API Reference
=============

.. toctree::
:maxdepth: 2

.. automodule:: package_name.core
:members:
2 changes: 1 addition & 1 deletion _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '',
VERSION: '0.0.1',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
10 changes: 7 additions & 3 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Index &#8212; No Errors Test Project documentation</title>
<title>Index &#8212; specless 0.0.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand Down Expand Up @@ -45,7 +45,7 @@ <h1 id="index">Index</h1>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">No Errors Test Project</a></h1>
<h1 class="logo"><a href="index.html">specless</a></h1>



Expand All @@ -55,6 +55,10 @@ <h1 class="logo"><a href="index.html">No Errors Test Project</a></h1>


<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
Expand Down Expand Up @@ -86,7 +90,7 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, sphinx-action Test Suite.
&copy;2019, Kandai Watanabe.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
Expand Down
22 changes: 17 additions & 5 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Welcome to No Errors Test Project’s documentation! &#8212; No Errors Test Project documentation</title>
<title>Welcome to package_name’s documentation! &#8212; specless 0.0.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand All @@ -14,6 +14,7 @@
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API Reference" href="reference.html" />

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

Expand All @@ -30,9 +31,15 @@

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

<div class="section" id="welcome-to-no-errors-test-project-s-documentation">
<h1>Welcome to No Errors Test Project’s documentation!<a class="headerlink" href="#welcome-to-no-errors-test-project-s-documentation" title="Permalink to this headline"></a></h1>
<div class="section" id="welcome-to-package-name-s-documentation">
<h1>Welcome to package_name’s documentation!<a class="headerlink" href="#welcome-to-package-name-s-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a><ul class="simple">
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
Expand All @@ -51,7 +58,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="#">No Errors Test Project</a></h1>
<h1 class="logo"><a href="#">specless</a></h1>



Expand All @@ -61,11 +68,16 @@ <h1 class="logo"><a href="#">No Errors Test Project</a></h1>


<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="reference.html" title="next chapter">API Reference</a></li>
</ul></li>
</ul>
</div>
Expand All @@ -92,7 +104,7 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, sphinx-action Test Suite.
&copy;2019, Kandai Watanabe.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
Expand Down
6 changes: 2 additions & 4 deletions objects.inv
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Sphinx inventory version 2
# Project: No Errors Test Project
# Project: specless
# Version:
# The remainder of this file is compressed using zlib.
x�m��
1D�|��'��[X(
�1r'IV�{������%z�D�a����>{\H�/�="R��0��NS��(���F�8 :N e�2�J�"��(��Op��݅^�!!�՞��$��������C�����6�W�]�[`�[N�
x�m�1�0 E����H�l��*QH>iEWI*��kp=NB��P$6��g?��k���Zy��bCfJ�ur��q_L��q�U�@����&�^:��H�9�$S�~%�?��^�E��g�YL�+��R� �®*�0G"BU�:r��c��S���\�
Expand Down
110 changes: 110 additions & 0 deletions reference.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>API Reference &#8212; specless 0.0.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Welcome to package_name’s documentation!" href="index.html" />

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


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>


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


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

<div class="section" id="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
</div>


</div>

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








<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul class="simple">
</ul>
</li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to package_name’s documentation!</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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>








</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, Kandai Watanabe.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

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




</body>
</html>
10 changes: 7 additions & 3 deletions search.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Search &#8212; No Errors Test Project documentation</title>
<title>Search &#8212; specless 0.0.1 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

Expand Down Expand Up @@ -65,7 +65,7 @@ <h1 id="search-documentation">Search</h1>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">No Errors Test Project</a></h1>
<h1 class="logo"><a href="index.html">specless</a></h1>



Expand All @@ -75,6 +75,10 @@ <h1 class="logo"><a href="index.html">No Errors Test Project</a></h1>


<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
Expand All @@ -96,7 +100,7 @@ <h3>Related Topics</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, sphinx-action Test Suite.
&copy;2019, Kandai Watanabe.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7ccb1f6

Please sign in to comment.