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

docs: switch docs to pydata theme, add initial gallery, add some type checks #406

Merged
merged 23 commits into from
Apr 22, 2024

Conversation

jonas-eschle
Copy link
Contributor

@jonas-eschle jonas-eschle commented Nov 29, 2022

Change to pydata and add a gallery top level as discussed in #405

@andrzejnovak
Copy link
Member

Hmm, the Gallery doesn't seem to show up in the docs preview

@jonas-eschle
Copy link
Contributor Author

Yep, not yet, it's still WIP, I fixed it now and added a small example (but at this point, I am not great with Sphinx tbh to create something nice)

@jonas-eschle
Copy link
Contributor Author

Hi @andrzejnovak , I've finally added something more useful to the gallery, it shows up and has two examples. It's probably not the most elegant way, but alas, better than nothing and gives a good idea of what is available.

Also fixed some typos here and there, the docs compile now without errors/warnings

@jonas-eschle jonas-eschle changed the title WIP: switch docs to pydata theme Upgrade docs: switch docs to pydata theme, add initial gallery Apr 16, 2024
@jonas-eschle
Copy link
Contributor Author

Okay, that was tricky with the path. Now sphinx complains, but it works. Before, it didn't complain and the pathes didn't work.

Better complaining and working than the other way around. Probably needs some better structure. But as said, it's there and works for now, provides a good overview in a simple manner.

@andrzejnovak andrzejnovak changed the title Upgrade docs: switch docs to pydata theme, add initial gallery docs: switch docs to pydata theme, add initial gallery, add some type checks Apr 22, 2024
@andrzejnovak andrzejnovak merged commit f15227c into master Apr 22, 2024
9 checks passed
@andrzejnovak andrzejnovak deleted the pydata branch April 22, 2024 18:45
jonas-eschle added a commit that referenced this pull request Apr 22, 2024
… checks (#406)

* docs: use pydata theme

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* docs: fix one whitespace too much (Sphinx...)

* docs: fix pathes, add jupyter execute

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* enh: add first draft of style plots

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* docs: add first gallery with plots for styles and labels

* fix: path for jupyter execute

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: path for jupyter execute

* fix: typo

* fix: typo

* fix: typo

* debug RTD

* fix: pathes...

* fix: pathes...maybe?

* fix: pathes...maybe? hacky

* fix: pathes...maybe? hacky

* fix: pathes...maybe? hacky

* chore: fix mypy issues

* fix: typo

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
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.

None yet

2 participants