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.

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

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

Merged
merged 5 commits into from
Jun 21, 2024
Merged

Conversation

joanise
Copy link
Member

@joanise joanise commented Jun 20, 2024

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

Copy link

codecov bot commented Jun 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@joanise
Copy link
Member Author

joanise commented Jun 20, 2024

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/

@joanise joanise merged commit 2e44e50 into main Jun 21, 2024
3 of 4 checks passed
@joanise joanise deleted the dev.ej/mkdocs branch June 21, 2024 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Convert the documentation in docs/ to mkdocs and mike
1 participant