ReadAlongs / Studio

Audiobook alignment for Indigenous languages
https://readalongs.github.io/Studio/
Other
38 stars 20 forks source link

Convert the documentation from sphinx .rst to mkdocs .md #223

Closed joanise closed 4 months ago

joanise commented 4 months ago

PR Goal?

Convert our documentation from Sphinx to mkdocs

A few updates to the docs were made, but mostly it's just conversion.

Fixes?

Fixes #213

Feedback sought?

1) Check that the general results are correct (see temporary deployment at https://joanise.github.io/ReadAlong-Studio/dev/) 2) take a look at the code 3) Next, I want to discuss how to change the live deployment without loosing all our previously published versions at https://readalong-studio.readthedocs.io/ where we have five older versions going back to 2021.

Priority?

normal

Tests added?

Tested locally, and on my fork.

How to test?

Locally, check out the PR branch, and run:

pip install -r docs/requirements.txt
mike serve

then navigate to http://localhost:8000

Or, I'm repeating myself, check my temporary deployment at https://joanise.github.io/ReadAlong-Studio/dev/

Confidence?

Good for the rendering of the current version of the docs.

N/A for how to deploy, since I did not solve that yet.

This PR is ready to review in terms of looking at the current results, but it is not ready to merge since it doesn't deploy.

Version change?

no

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.23%. Comparing base (396b2f1) to head (f3d2f05). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #223 +/- ## ========================================== - Coverage 87.45% 87.23% -0.23% ========================================== Files 21 21 Lines 1770 1770 Branches 321 321 ========================================== - Hits 1548 1544 -4 - Misses 186 189 +3 - Partials 36 37 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

joanise commented 4 months ago

Update: I just changed the URL to check to https://joanise.github.io/ReadAlong-Studio/dev/ instead of https://joanise.github.io/ReadAlong-Studio/ because I added an older version https://joanise.github.io/ReadAlong-Studio/v1.0.20230228/