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

Clarifications for migration guides #527

Merged
merged 4 commits into from
Oct 16, 2024
Merged

Clarifications for migration guides #527

merged 4 commits into from
Oct 16, 2024

Conversation

utensil
Copy link
Member

@utensil utensil commented Oct 16, 2024

Fixes #525

Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.96%. Comparing base (644a32a) to head (f1825be).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #527   +/-   ##
=======================================
  Coverage   78.95%   78.96%           
=======================================
  Files          19       19           
  Lines        4400     4402    +2     
=======================================
+ Hits         3474     3476    +2     
  Misses        926      926           

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

@utensil
Copy link
Member Author

utensil commented Oct 16, 2024

Doc build failed due to

/home/docs/checkouts/readthedocs.org/user_builds/galgebra/checkouts/527/doc/installation.rst:1: ERROR: Error in "mdinclude" directive:
unknown option: "start-after".

.. mdinclude:: ../README.md
    :start-after: <!-- begin: installation -->
    :end-before: <!-- end: installation --> [docutils]
/home/docs/checkouts/readthedocs.org/user_builds/galgebra/checkouts/527/doc/migration.rst:1: ERROR: Error in "mdinclude" directive:
unknown option: "start-after".

.. mdinclude:: ../README.md
    :start-after: <!-- begin: migration -->
    :end-before: <!-- end: migration --> [docutils]

But this option seems to be still there per https://www.docutils.org/docs/ref/rst/directives.html .

@utensil utensil force-pushed the fix-migration-guide branch from a6f8b2a to a34d2d7 Compare October 16, 2024 13:13
@utensil
Copy link
Member Author

utensil commented Oct 16, 2024

Nice, now doc build passes. The cause was incompatible theme version (jumped to 3.x.x which is not meant to be compatible), so I fixed it to the earlier one.

I should have fixed all deps to a version to avoid this happen again.

@utensil utensil force-pushed the fix-migration-guide branch from c3b8145 to c394642 Compare October 16, 2024 13:52
@utensil utensil merged commit 327df0a into master Oct 16, 2024
10 checks passed
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.

Improve Migrating guide for readers of LAGA&VAGC
1 participant