Skip to content

Commit 71cfc5b

Browse files
daveronandaveronan
authored
Merge pull request #2 from roex-audio/update-readme
added docs
2 parents 820be13 + 659da4e commit 71cfc5b

File tree

89 files changed

+13004
-2
lines changed

Some content is hidden

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

89 files changed

+13004
-2
lines changed

‎Makefile‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
SPHINXOPTS ?=
77
SPHINXBUILD ?= sphinx-build
88
SOURCEDIR = .
9-
BUILDDIR = _build
9+
BUILDDIR = docs
1010

1111
# Put it first so that "make" without argument is like "make help".
1212
help:
@@ -17,4 +17,16 @@ help:
1717
# Catch-all target: route all unknown targets to Sphinx using the new
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1919
%: Makefile
20-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
20+
@echo "Building $@..."
21+
@$(SPHINXBUILD) -b $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
22+
23+
# Special handling for 'html' target to avoid subdirectory
24+
.PHONY: html
25+
html: Makefile
26+
@echo "Building html directly into $(BUILDDIR)..."
27+
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
28+
29+
.PHONY: clean
30+
clean:
31+
@echo "Cleaning $(BUILDDIR)..."
32+
@rm -rf "$(BUILDDIR)"/*

‎docs/.buildinfo‎

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

‎docs/.doctrees/api.doctree‎

625 KB
Binary file not shown.

‎docs/.doctrees/environment.pickle‎

2.45 MB
Binary file not shown.

‎docs/.doctrees/index.doctree‎

7.34 KB
Binary file not shown.

‎docs/.nojekyll‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎docs/_modules/index.html‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" data-content_root="../">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>Overview: module code &mdash; roex-python 1.2 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
10+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
11+
12+
13+
<script src="../_static/jquery.js?v=5d32c60e"></script>
14+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15+
<script src="../_static/documentation_options.js?v=61243dd2"></script>
16+
<script src="../_static/doctools.js?v=9bcbadda"></script>
17+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
18+
<script src="../_static/js/theme.js"></script>
19+
<link rel="index" title="Index" href="../genindex.html" />
20+
<link rel="search" title="Search" href="../search.html" />
21+
</head>
22+
23+
<body class="wy-body-for-nav">
24+
<div class="wy-grid-for-nav">
25+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
26+
<div class="wy-side-scroll">
27+
<div class="wy-side-nav-search" >
28+
29+
30+
31+
<a href="../index.html" class="icon icon-home">
32+
roex-python
33+
</a>
34+
<div role="search">
35+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
36+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
37+
<input type="hidden" name="check_keywords" value="yes" />
38+
<input type="hidden" name="area" value="default" />
39+
</form>
40+
</div>
41+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
42+
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
43+
<ul>
44+
<li class="toctree-l1"><a class="reference internal" href="../api.html">API Reference</a></li>
45+
</ul>
46+
47+
</div>
48+
</div>
49+
</nav>
50+
51+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
52+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
53+
<a href="../index.html">roex-python</a>
54+
</nav>
55+
56+
<div class="wy-nav-content">
57+
<div class="rst-content">
58+
<div role="navigation" aria-label="Page navigation">
59+
<ul class="wy-breadcrumbs">
60+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
61+
<li class="breadcrumb-item active">Overview: module code</li>
62+
<li class="wy-breadcrumbs-aside">
63+
</li>
64+
</ul>
65+
<hr/>
66+
</div>
67+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
68+
<div itemprop="articleBody">
69+
70+
<h1>All modules for which code is available</h1>
71+
<ul><li><a href="roex_python/client.html">roex_python.client</a></li>
72+
<li><a href="roex_python/controllers/analysis_controller.html">roex_python.controllers.analysis_controller</a></li>
73+
<li><a href="roex_python/controllers/audio_cleanup_controller.html">roex_python.controllers.audio_cleanup_controller</a></li>
74+
<li><a href="roex_python/controllers/enhance_controller.html">roex_python.controllers.enhance_controller</a></li>
75+
<li><a href="roex_python/controllers/mastering_controller.html">roex_python.controllers.mastering_controller</a></li>
76+
<li><a href="roex_python/controllers/mix_controller.html">roex_python.controllers.mix_controller</a></li>
77+
<li><a href="roex_python/controllers/upload_controller.html">roex_python.controllers.upload_controller</a></li>
78+
<li><a href="roex_python/models/analysis.html">roex_python.models.analysis</a></li>
79+
<li><a href="roex_python/models/audio_cleanup.html">roex_python.models.audio_cleanup</a></li>
80+
<li><a href="roex_python/models/enhance.html">roex_python.models.enhance</a></li>
81+
<li><a href="roex_python/models/mastering.html">roex_python.models.mastering</a></li>
82+
<li><a href="roex_python/models/mixing.html">roex_python.models.mixing</a></li>
83+
<li><a href="roex_python/models/upload.html">roex_python.models.upload</a></li>
84+
<li><a href="roex_python/providers/api_provider.html">roex_python.providers.api_provider</a></li>
85+
<li><a href="roex_python/utils.html">roex_python.utils</a></li>
86+
</ul>
87+
88+
</div>
89+
</div>
90+
<footer>
91+
92+
<hr/>
93+
94+
<div role="contentinfo">
95+
<p>&#169; Copyright 2025, RoEx LTD.</p>
96+
</div>
97+
98+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
99+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
100+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
101+
102+
103+
</footer>
104+
</div>
105+
</div>
106+
</section>
107+
</div>
108+
<script>
109+
jQuery(function () {
110+
SphinxRtdTheme.Navigation.enable(true);
111+
});
112+
</script>
113+
114+
</body>
115+
</html>

0 commit comments

Comments
 (0)