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

Change sphinx docs to pydata theme #108

Conversation

smokestacklightnin
Copy link
Contributor

@smokestacklightnin smokestacklightnin commented Aug 2, 2023

📝 Description

Type: 📝 documentation

This pull request changes the sphinx theme to the pydata theme

Installs pydata automatically using $ pip install -e .[docs]

📌 Resources

Here is a preview

Here is the current official STARDIS documentation for comparison

🚦 Testing

How did you test these changes?

  • Testing pipeline

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes

Installs pydata automatically using ``$ pip install -e .[docs]``
@codecov
Copy link

codecov bot commented Aug 2, 2023

Codecov Report

Merging #108 (9f50f58) into main (1d9daf7) will not change coverage.
The diff coverage is n/a.

❗ Current head 9f50f58 differs from pull request most recent head e7d284e. Consider uploading reports for the commit e7d284e to get more accurate results

@@           Coverage Diff           @@
##             main     #108   +/-   ##
=======================================
  Coverage   34.97%   34.97%           
=======================================
  Files          17       17           
  Lines         629      629           
=======================================
  Hits          220      220           
  Misses        409      409           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@smokestacklightnin smokestacklightnin marked this pull request as ready for review August 2, 2023 02:07
@atharva-2001 atharva-2001 added the benchmarks Trigger benchmarks to run on this pr label Aug 2, 2023
@jvshields jvshields added documentation Improvements or additions to documentation and removed benchmarks Trigger benchmarks to run on this pr labels Aug 3, 2023
@jvshields
Copy link
Contributor

I might have missed a conversation somewhere, but why do we want to use the pydata theme instead of the rtd theme?

@smokestacklightnin
Copy link
Contributor Author

I might have missed a conversation somewhere, but why do we want to use the pydata theme instead of the rtd theme?

It was just to preview it since @wkerzendorf mentioned it.

@smokestacklightnin smokestacklightnin marked this pull request as draft August 7, 2023 04:01
@smokestacklightnin smokestacklightnin marked this pull request as ready for review August 7, 2023 17:40
@smokestacklightnin smokestacklightnin marked this pull request as draft August 9, 2023 21:10
@jvshields jvshields closed this Jan 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants