deploy: d2d3cc4

_sources/developer_guide/developers_install.rst.txt

@@ -46,6 +46,12 @@ And you can lint with:
 
     $ python -m black .
 
+and 
+
+.. code:: bash
+
+    $ python3 -m flake8 -v --show-source --max-line-length=92 moviepy docs/conf.py examples tests
+
 
 
 

_sources/developer_guide/index.rst.txt

@@ -11,3 +11,4 @@ The Developers Guide covers most of the things people wanting to participate to
 
    developers_install
    contribution_guidelines
+   maintainers_publish

_sources/developer_guide/maintainers_publish.rst.txt

@@ -0,0 +1,59 @@
+.. _maintainers_publish:
+
+Publishing a New Version of MoviePy
+===================================
+
+This section is for maintainers responsible for publishing new versions of MoviePy. Follow these steps to ensure the process is smooth and consistent:
+
+**Pre-requisites**
+------------------
+- Ensure you have proper permissions to push changes and create releases in the MoviePy repository.
+
+Steps to Publish a New Version
+------------------------------
+
+1. **Update the `CHANGELOG.md`**
+
+   - Add a new section for the upcoming version, respecting the format used in previous entries.
+   - Summarize all changes, fixes, and new features.
+
+2. **Update the version in `pyproject.toml`**
+
+   - Open the `pyproject.toml` file.
+   - Update the `version` field to the new version, following `Semantic Versioning <https://semver.org/>`_.
+
+3. **Commit and Push**
+
+   - Stage your changes::
+
+        git add CHANGELOG.md pyproject.toml
+
+   - Commit your changes::
+
+        git commit -m "Release vX.Y.Z"
+
+   - Push your changes::
+
+        git push
+
+4. **Create a New Tag**
+
+   - Create a tag for the new version (replace ``vX.Y.Z`` with the actual version number)::
+
+        git tag -a vX.Y.Z -m "Release vX.Y.Z"
+
+   - Push the tag to the remote repository::
+
+        git push origin vX.Y.Z
+
+5. **Create a New Release**
+
+   - Go to the repository's page on GitHub (or the relevant hosting platform).
+   - Navigate to the "Releases" section and create a new release.
+   - Use the new tag (``vX.Y.Z``) and provide a description for the release.
+     - Copy the changelog for this version into the release description.
+   - Publish the release.
+
+GitHub actions will automatically build and publish the new release on PyPi.
+
+By following these steps, you ensure that each MoviePy release is well-documented, correctly versioned, and accessible to users.

developer_guide/contribution_guidelines.html

@@ -44,6 +44,7 @@
     <script>DOCUMENTATION_OPTIONS.pagename = 'developer_guide/contribution_guidelines';</script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="Publishing a New Version of MoviePy" href="maintainers_publish.html" />
     <link rel="prev" title="Installation for MoviePy developers" href="developers_install.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
@@ -335,6 +336,7 @@
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="developers_install.html">Installation for MoviePy developers</a></li>
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">MoviePy’s Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="maintainers_publish.html">Publishing a New Version of MoviePy</a></li>
 </ul>
 </div>
 </nav></div>
@@ -479,6 +481,15 @@ <h3>Submitting Pull Requests<a class="headerlink" href="#submitting-pull-request
         <p class="prev-next-title">Installation for MoviePy developers</p>
       </div>
     </a>
+    <a class="right-next"
+       href="maintainers_publish.html"
+       title="next page">
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">next</p>
+        <p class="prev-next-title">Publishing a New Version of MoviePy</p>
+      </div>
+      <i class="fa-solid fa-angle-right"></i>
+    </a>
 </div>
                 </footer>
 

developer_guide/developers_install.html

@@ -336,6 +336,7 @@
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">Installation for MoviePy developers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contribution_guidelines.html">MoviePy’s Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="maintainers_publish.html">Publishing a New Version of MoviePy</a></li>
 </ul>
 </div>
 </nav></div>
@@ -426,6 +427,10 @@ <h2>Libraries for testing and linting<a class="headerlink" href="#libraries-for-
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>black<span class="w"> </span>.
 </pre></div>
 </div>
+<p>and</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>python3<span class="w"> </span>-m<span class="w"> </span>flake8<span class="w"> </span>-v<span class="w"> </span>--show-source<span class="w"> </span>--max-line-length<span class="o">=</span><span class="m">92</span><span class="w"> </span>moviepy<span class="w"> </span>docs/conf.py<span class="w"> </span>examples<span class="w"> </span>tests
+</pre></div>
+</div>
 </section>
 </section>
 

developer_guide/index.html

@@ -336,6 +336,7 @@
   <div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="developers_install.html">Installation for MoviePy developers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contribution_guidelines.html">MoviePy’s Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="maintainers_publish.html">Publishing a New Version of MoviePy</a></li>
 </ul>
 </div>
 </nav></div>
@@ -397,6 +398,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="developers_install.html">Installation for MoviePy developers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contribution_guidelines.html">MoviePy’s Contribution Guidelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="maintainers_publish.html">Publishing a New Version of MoviePy</a></li>
 </ul>
 </div>
 </section>