60ff645750
I've been running into variations in style in the docs I've edited so far. I've been including changes for consistency in with other commits but in many cases that makes one part of one doc more consistent with the rest but less consistent with itself. It seems like a bit of cleanup may be in order. This change applies the following conventions: - Section heading heirarchy: #. ``=`` with overline for document title, IOW first heading #. ``-`` #. ``~`` #. ``"`` - Two newlines before ``-`` sections for readability - A newline between every section of any level and the first line of text - Wrap paragraph lines at 88 characters to match Python's Black I've only applied these changes to those ``*.rst`` files that aren't generated. In the future, I might suggest another bulk change to match [the Sphinx conventions for section headings](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections).
49 lines
1.2 KiB
ReStructuredText
49 lines
1.2 KiB
ReStructuredText
====================
|
|
Environment Agnostic
|
|
====================
|
|
|
|
The PIP install method is not recommended; use of this method may cause unintended
|
|
requirement conflicts if you have other locally installed apps that depend on ffmpeg.
|
|
|
|
|
|
PIP Install
|
|
--------------
|
|
|
|
You can install our `PyPI package <https://pypi.org/project/ytdl-sub/>`_. Both ffmpeg
|
|
and Python 3.10 or greater are required.
|
|
|
|
.. code-block:: bash
|
|
|
|
python3 -m pip install -U ytdl-sub
|
|
|
|
Install for Development
|
|
=======================
|
|
|
|
These environment-agnostic methods of installing ``ytdl-sub`` are meant for local
|
|
development of ``ytdl-sub``. If you want to contribute your changes, please read
|
|
:doc:`/guides/development/index`.
|
|
|
|
Local Install
|
|
--------------
|
|
|
|
With a Python 3.10 virtual environment, you can clone and install the repo.
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone https://github.com/jmbannon/ytdl-sub.git
|
|
cd ytdl-sub
|
|
|
|
pip install -e .
|
|
|
|
Local Docker Build
|
|
-------------------
|
|
|
|
Run ``make docker`` in the root directory of this repo to build the image. This will
|
|
build the python wheel and install it in the Dockerfile.
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone https://github.com/jmbannon/ytdl-sub.git
|
|
cd ytdl-sub
|
|
|
|
make docker
|