CSCI128 / 101GradingScript

Script designed to move grades between Gradescope and Canvas
https://gradingscript.trihardstudios.com/#/
0 stars 0 forks source link

[DOCUMENTATION] Migrate to Read The Docs from docsify #44

Closed gregbell26 closed 1 year ago

gregbell26 commented 1 year ago

Module Name

All Modules

Effected Files

All Files

Requesting

~- [ ] New / Missing Documentation~

Other Information

Due to lackluster support with Sphinx for Markdown, as well as the cluttered mess that is the current documentation system, I want to migrate to ReadTheDocs with a more standard Sphinx HTML built site. This is more consistent with industry standards and should help make the repo more accessible for new users.

This should also allow the API documentation to build automatically without the issues with clayrisser/sphinx-markdown-builder. (Issues with nested lists and removing custom markdown tags like !> and ?>)

This will involve migrating the handwritten markdown to reStructuredText (RST), but that should not be too time-consuming as there are currently only 2 completed pages.