manual: update section on project structure, bump sphinx lib versions

This commit is contained in:
Alexandros Theodotou 2023-12-13 19:52:35 +09:00
parent e03e8fc635
commit e140a99991
No known key found for this signature in database
GPG Key ID: 022EAE42313D70F3
4 changed files with 17 additions and 22 deletions

View File

@ -49,6 +49,7 @@ extensions = [
'sphinx.ext.todo',
'sphinx_copybutton',
'sphinxcontrib.rsvgconverter',
'sphinx-prompt',
# 'sphinxcontrib.programoutput',
# 'sphinxcontrib.devhelp',
# 'recommonmark',

View File

@ -1,4 +1,4 @@
.. SPDX-FileCopyrightText: © 2020 Alexandros Theodotou <alex@zrythm.org>
.. SPDX-FileCopyrightText: © 2020, 2023 Alexandros Theodotou <alex@zrythm.org>
SPDX-License-Identifier: GFDL-1.3-invariants-or-later
This is part of the Zrythm Manual.
See the file index.rst for copying conditions.
@ -52,14 +52,6 @@ Zrythm executable.
Print version information.
.. cmdoption:: --zpj-to-yaml
Convert a .zpj project file to YAML.
.. cmdoption:: --yaml-to-zpj
Convert a YAML file to the .zpj format.
Prints the Zrythm version.
zrythm_launch

View File

@ -106,16 +106,17 @@ Project Directory
Project File Format
-------------------
Zrythm uses a custom
`MIME <https://en.wikipedia.org/wiki/MIME>`_ type
``x-zrythm-project`` (which is an alias of
``application/zstd``) for its project files
(``project.zpj``).
This is a
Zrythm project files (``project.zpj``) are
`zstd <https://facebook.github.io/zstd/>`_-compressed
`YAML <http://yaml.org/>`_ file that can be
decompressed (converted to YAML) for inspection using
:option:`zrythm --zpj-to-yaml`.
`JSON <https://www.json.org/>`_ files (the project file
`MIME type <https://en.wikipedia.org/wiki/MIME>`_
``x-zrythm-project`` is an alias of ``application/zstd``).
Project files can be converted to JSON using:
.. prompt:: bash
zstd -d project.zpj -o project.json
Audio Pool
----------

View File

@ -5,7 +5,7 @@ certifi==2023.7.22
charset-normalizer==3.2.0
click==8.1.6
docutils==0.20.1
furo==2023.7.26
furo==2023.9.10
gprof2dot==2022.7.29
idna==3.4
imagesize==1.4.1
@ -16,15 +16,16 @@ Pygments==2.16.1
requests==2.31.0
snowballstemmer==2.2.0
soupsieve==2.4.1
Sphinx==7.1.2
Sphinx==7.2.6
sphinx-basic-ng==1.0.0b2
sphinx-copybutton==0.5.2
sphinx-intl==2.1.0
sphinx-prompt==1.8.0
sphinxcontrib-applehelp==1.0.6
sphinxcontrib-devhelp==1.0.4
sphinxcontrib-htmlhelp==2.0.3
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.5
sphinxcontrib-serializinghtml==1.1.7
sphinxcontrib-serializinghtml==1.1.9
sphinxcontrib-svg2pdfconverter==1.2.2
urllib3==2.0.4
urllib3==2.1.0