Merge branch 'sphinx_doc' into 'dev'

Add library documentation See merge request apiekarz/wimu-project-z5!3
salu133445 · Jan 14, 2024 · 8caae67 · 8caae67
2 parents 4939b82 + 5064984
commit 8caae67
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 7 deletions.
diff --git a/doc/source/io/abc.rst b/doc/source/io/abc.rst
@@ -4,3 +4,6 @@ ABC Interface
 
 .. autofunction:: muspy.read_abc
     :noindex:
+
+.. autofunction:: muspy.write_abc
+    :noindex:
diff --git a/docs/io/abc.html b/docs/io/abc.html
@@ -10,7 +10,7 @@
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
-  
+
         <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
         <script src="../_static/jquery.js"></script>
         <script src="../_static/underscore.js"></script>
@@ -19,10 +19,10 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="JSON Interface" href="json.html" />
-    <link rel="prev" title="MusicXML Interface" href="musicxml.html" /> 
+    <link rel="prev" title="MusicXML Interface" href="musicxml.html" />
 </head>
 
-<body class="wy-body-for-nav"> 
+<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">
@@ -87,7 +87,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-             
+
   <section id="abc-interface">
 <h1>ABC Interface<a class="headerlink" href="#abc-interface" title="Permalink to this headline"></a></h1>
 <dl class="py function">
@@ -112,6 +112,20 @@ <h1>ABC Interface<a class="headerlink" href="#abc-interface" title="Permalink to
 </dl>
 </dd></dl>
 
+<dl class="py function">
+  <dt class="sig sig-object py">
+  <span class="sig-prename descclassname"><span class="pre">muspy.</span></span><span class="sig-name descname"><span class="pre">write_abc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">music</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/muspy/outputs/abc.html#write_abc"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+  <dd><p>Write a Music object to an ABC file.</p>
+  <dl class="field-list simple">
+  <dt class="field-odd">Parameters</dt>
+  <dd class="field-odd"><ul class="simple">
+  <li><p><strong>path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a><em> or </em><em>Path</em>) – Path to write the ABC file.</p></li>
+  <li><p><strong>music</strong> (<a class="reference internal" href="../doc/muspy.html#muspy.Music" title="muspy.Music"><code class="xref py py-class docutils literal notranslate"><span class="pre">muspy.Music</span></code></a>) – Music object to write.</p></li>
+  </ul>
+  </dd>
+  </dl>
+  </dd></dl>
+
 </section>
 
 
@@ -131,7 +145,7 @@ <h1>ABC Interface<a class="headerlink" href="#abc-interface" title="Permalink to
   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>
@@ -142,7 +156,7 @@ <h1>ABC Interface<a class="headerlink" href="#abc-interface" title="Permalink to
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
 
 </body>
-</html>
+</html>