docs: initial attempt to convert docs to use mkdocs #1724
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
ACTION NEEDED delta-rs follows the Conventional Commits specification for release automation. The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification. |
r3stl355
changed the title
r3stl355
changed the title
|
this is just a draft, I will change everywhere once I get a go ahead but don't want to do all that upfront - that's a lot of potentually unneeded if I missed something |
|
Please ignore the deleted code when reviewing this - looks like i messed up my merge, focus on docs changes only. I'll make sure all is properly merged before I submit the full PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I fixed most of the tasks in the issue #1708 but did not make all the changes to docstrings. Submitting this to get early feedback before making larger changes. Please review
API Reference -> Delta Tablefor most changes.I also suggest changing theme from
readthedocstomkdocs- both built in but latter looks sleeker. Just change the value inmkdocs.yamlto see.Related Issue(s)
#1708