Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Dev.ej/prep for mkdocs #224

Merged
merged 2 commits into from
Jun 21, 2024
Merged

Dev.ej/prep for mkdocs #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7559b3d
fix(docs): fix errors in sphinx docs before conversion to mkdocs
joanise Jun 20, 2024
a80c35e
docs: put a link on the old docs location to the new one
joanise Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/cli-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The result of ``tokenize`` or ``g2p`` can be fixed manually if necessary and
then used as input to ``align``.

Getting from TXT to XML with readalongs make-xml
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Run :ref:`cli-make-xml` to make the ReadAlongs XML file for ``align`` from a TXT file.

Expand All @@ -60,7 +60,7 @@ breaks are marked by two blank lines.
| | and will be aligning repeatedly) |
+-----------------------------------+-----------------------------------------------+
| ``-h, --help`` | Displays CLI guide for |
| | ``make-xml`` |
| | ``make-xml`` |
+-----------------------------------+-----------------------------------------------+

The ``-l, --language`` argument requires a language’s 3 character `ISO
Expand Down
2 changes: 1 addition & 1 deletion docs/cli-ref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ e.g., ``readalongs -h``, ``readalongs align --help``.
:prog: readalongs align

.. _cli-make-xml:
.. click:: readalongs.cli:make-xml
.. click:: readalongs.cli:make_xml
:prog: readalongs make-xml

.. _cli-tokenize:
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Welcome to ReadAlong-Studio's documentation
===========================================

.. WARNING:: Historical documentation. This site holds documentation for the ReadAlong-Studio (CLI) up to v1.0.20230228. For the latest documentation, please visit https://readalongs.github.io/Studio/.

Audiobook alignment for Indigenous languages

This site provides the full user documentation for ReadAlongs-Studio.
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ Sphinx
guzzle_sphinx_theme
sphinx-click
sphinxcontrib-programoutput
-r ../requirements.txt
-r ../requirements.min.txt
Loading