-
-
Notifications
You must be signed in to change notification settings - Fork 125
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
Migrating from sphinx to Material for MkDocs #715
Conversation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor changes, but LGTM overall. Thanks for all the hard work, @DeaMariaLeon!
I think I addressed all the requested changes. Please let me know if something is missing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor missed changes, then we're all good.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this heavy lift and your patience, @DeaMariaLeon! Let's get this in and iterate on it at this point.
Thank you @hameerabbasi ! |
This is a work in progress in case you want to see locally what I have done.
As you know, if you download my branch, one can see the docs locally running
mkdocs serve
.Please note that these points are still pending before starting the next step of adding more documentation.
Cross-reference links.The rest of the mainBut need links fixedrst
pages like install, construct, etc, are still missing.Some format on the API documents need to be fixed as well. Like the area of the examples.Headers,logo,footersneed to be added.Website needs to be deployed with mkdocs instead of Sphinx@hameerabbasi @mtsokol