Skip to content

Commit

Permalink
fix(docs): fix errors in sphinx docs before conversion to mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
joanise authored and roedoejet committed Jun 21, 2024
1 parent 396b2f1 commit 7548038
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/cli-guide.rst
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
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: 1 addition & 1 deletion docs/requirements.txt
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

0 comments on commit 7548038

Please sign in to comment.