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

Converting some files from .md to .rst and fixing the rendering and look of the pydata sphinx theme #116

Open
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

George-Elhamy
Copy link

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

  • [x ] Bug fix
  • [] New feature
  • Breaking change (Causes existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • I have documented my changes in /docs/changelog.md.
  • My change requires additional/updated documentation.
  • I have updated the documentation accordingly.
  • I have added/updated the config example for any module docstrings as necessary.
  • I have checked that the change does not contain obvious errors
    (syntax, indentation, mutable default values, etc.).
  • I have tested my changes using 'Load all modules' on the default dummy configuration.
  • All changed Jupyter notebooks have been stripped of their output cells.

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.

2 participants