Converting some files from .md to .rst and fixing the rendering and look of the pydata sphinx theme#116
Open
George-Elhamy wants to merge 22 commits into
Open
Converting some files from .md to .rst and fixing the rendering and look of the pydata sphinx theme#116George-Elhamy wants to merge 22 commits into
George-Elhamy wants to merge 22 commits into
Conversation
…s successfully build locally.
…I have not changed `README.md`, `PULL_REQUEST_TEMPLATE.md`, `AUTHORS.md`.
This file contains hidden or 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
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
The changes here are converting the .md files to .rst and also making changes to the pydata theme related to the .rst starting from adding the pydata sphinx theme to the dependencies and using it and movinfg forward to modifying files heirarchy, adding the logo, fixing hyperlinks.
Motivation and Context
Using .rst files instead of .md files is crucial since sphinx by default uses .rst files and also it has some edges like cross-referencing and directives. And the choice of using the pydata theme is because it is well structured and many libraries use it such as numpy, matplotlib for their documentation.
How Has This Been Tested?
Screenshots (only if appropriate, delete if not):
Types of changes
Checklist:
/docs/changelog.md.(syntax, indentation, mutable default values, etc.).