From 7559b3dc44ac9378a6b3a83b283e799730169982 Mon Sep 17 00:00:00 2001 From: Eric Joanis Date: Thu, 20 Jun 2024 10:14:18 -0400 Subject: [PATCH 1/2] fix(docs): fix errors in sphinx docs before conversion to mkdocs --- docs/cli-guide.rst | 4 ++-- docs/cli-ref.rst | 2 +- docs/requirements.txt | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/cli-guide.rst b/docs/cli-guide.rst index 8c1c4add..b92d580b 100644 --- a/docs/cli-guide.rst +++ b/docs/cli-guide.rst @@ -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. @@ -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 diff --git a/docs/cli-ref.rst b/docs/cli-ref.rst index 34afa0df..0b94f686 100644 --- a/docs/cli-ref.rst +++ b/docs/cli-ref.rst @@ -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: diff --git a/docs/requirements.txt b/docs/requirements.txt index a85ae383..16c6e0eb 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,4 @@ Sphinx guzzle_sphinx_theme sphinx-click sphinxcontrib-programoutput --r ../requirements.txt +-r ../requirements.min.txt From a80c35e118f889884b4849e111cf1e11e90337f8 Mon Sep 17 00:00:00 2001 From: Eric Joanis Date: Fri, 21 Jun 2024 14:27:17 -0400 Subject: [PATCH 2/2] docs: put a link on the old docs location to the new one --- docs/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index a99a1d92..4112748f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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.