-
Notifications
You must be signed in to change notification settings - Fork 310
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOCS: Update front page, contributing doc, and gallery code (#825)
- Loading branch information
Showing
81 changed files
with
475 additions
and
508 deletions.
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
# Contributing to this theme | ||
|
||
Contributions are very welcome! Installing the development version, building | ||
the demo docs and developing the css/js of the theme, etc, is explained in | ||
the example docs and developing the css/js of the theme, etc, is explained in | ||
more detail in the contributing section of the documentation: | ||
|
||
- [Contributing source files](docs/contribute/index.md) | ||
- [Contributing rendered docs](https://pydata-sphinx-theme.readthedocs.io/en/latest/contribute/index.html) | ||
- [Community and contribution guide source](docs/community/index.md) | ||
- [Community and contribution guide rendered docs](https://pydata-sphinx-theme.readthedocs.io/en/latest/community/index.html) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
- header: "@bollwyvl" | ||
image: https://avatars.githubusercontent.com/u/45380 | ||
link: https://github.com/bollwyvl | ||
- header: "@jarrodmillman" | ||
image: https://avatars.githubusercontent.com/u/123428 | ||
link: https://github.com/jarrodmillman | ||
- header: "@hoetmaaiers" | ||
image: https://avatars.githubusercontent.com/u/468045 | ||
link: https://github.com/hoetmaaiers | ||
- header: "@jorisvandenbossche" | ||
image: https://avatars.githubusercontent.com/u/1020496 | ||
link: https://github.com/jorisvandenbossche | ||
- header: "@damianavila" | ||
image: https://avatars.githubusercontent.com/u/1640669 | ||
link: https://github.com/damianavila | ||
- header: "@drammock" | ||
image: https://avatars.githubusercontent.com/u/1810515 | ||
link: https://github.com/drammock | ||
- header: "@choldgraf" | ||
image: https://avatars.githubusercontent.com/u/1839645 | ||
link: https://github.com/choldgraf | ||
- header: "@12rambau" | ||
image: https://avatars.githubusercontent.com/u/12596392 | ||
link: https://github.com/12rambau |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Metadata to create our example gallery. This YAML file does two things: | ||
# | ||
# 1. Used by `generate_gallery_images.py` to take snapshots of each item and place an image in `gallery`. | ||
# 2. Used by our Gallery Grid directive to create the grid on our `examples/gallery.md` page. | ||
# | ||
# title: The title of each gallery item | ||
# website: The website that will be used to create a snapshot of this item. | ||
# An image will be placed in docs/_static/gallery/{sanitized_title}.png | ||
# img-bottom: The location where img-bottoms will be placed for each entry by generate_gallery_img-bottoms.py | ||
# This should follow the form shown above and is roughly the same for all items. | ||
- title: Pandas | ||
website: https://pandas.pydata.org/docs/ | ||
img-bottom: ../_static/gallery/pandas.png | ||
- title: NumPy | ||
website: https://numpy.org/doc/stable/ | ||
img-bottom: ../_static/gallery/numpy.png | ||
- title: SciPy | ||
website: https://docs.scipy.org/doc/scipy/ | ||
img-bottom: ../_static/gallery/scipy.png | ||
- title: Bokeh | ||
website: https://docs.bokeh.org/en/latest/ | ||
img-bottom: ../_static/gallery/bokeh.png | ||
- title: CuPy | ||
website: https://docs.cupy.dev/en/stable/index.html | ||
img-bottom: ../_static/gallery/cupy.png | ||
- title: PyVista | ||
website: https://docs.pyvista.org | ||
img-bottom: ../_static/gallery/pyvista.png | ||
- title: MNE-Python | ||
website: https://mne.tools/stable/index.html | ||
img-bottom: ../_static/gallery/mne-python.png | ||
- title: NetworkX | ||
website: https://networkx.org/documentation/stable/ | ||
img-bottom: ../_static/gallery/networkx.png | ||
- title: Fairlearn | ||
website: https://fairlearn.org/main/about/ | ||
img-bottom: ../_static/gallery/fairlearn.png | ||
- title: Jupyter Book | ||
website: https://jupyterbook.org/en/stable/intro.html | ||
img-bottom: ../_static/gallery/jupyter_book.png | ||
- title: Binder | ||
website: https://mybinder.readthedocs.io/en/latest/index.html | ||
img-bottom: ../_static/gallery/binder.png | ||
- title: Jupyter | ||
website: https://docs.jupyter.org/en/latest/ | ||
img-bottom: ../_static/gallery/jupyter.png | ||
- title: MegEngine | ||
website: https://www.megengine.org.cn/doc/stable/en/index.html | ||
img-bottom: ../_static/gallery/megengine.png | ||
- title: Feature-engine | ||
website: https://feature-engine.readthedocs.io/ | ||
img-bottom: ../_static/gallery/feature-engine.png |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Contributors to this theme | ||
|
||
This theme is supported and developed by various members of [the PyData community](https://pydata.org). | ||
|
||
## Collaborators on the repository | ||
|
||
Here is a grid of collaborators on our GitHub repository. | ||
We don't yet have formal "team definitions" so this is mostly a reflection of who has commit rights to the repository. | ||
|
||
```{gallery-grid} ../_static/contributors.yaml | ||
:class-card: text-center | ||
``` | ||
|
||
## Financial support | ||
|
||
Support and development for this theme has been funded by one [NumFocus Small Development Grant](https://numfocus.org/programs/small-development-grants) on behalf of several communities in the PyData ecosystem. | ||
|
||
## Theme logo | ||
|
||
Thanks to [@drammock](https://github.com/drammock) for initial design of the theme logo. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
myst: | ||
html_meta: | ||
"description lang=en": "How to become a contributor to the pydata-sphinx-theme." | ||
--- | ||
|
||
# Community Guide | ||
|
||
These pages contain information about the community that leads, supports, and develops this theme, including how you can contribute to the project. | ||
|
||
```{toctree} | ||
:maxdepth: 2 | ||
:caption: Contributor Guide | ||
setup | ||
structure | ||
topics | ||
manual | ||
``` | ||
|
||
```{toctree} | ||
:maxdepth: 2 | ||
:caption: About the project | ||
contributors | ||
policies | ||
inspiration | ||
``` |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Inspiration for design and UX | ||
|
||
To build this theme we drew inspiration from other great projects on the web that we would like to acknowledge here. | ||
When making new decisions about design and UI/UX, we often consult these themes to see what they're doing. | ||
|
||
```{gallery-grid} | ||
:grid-columns: 1 2 2 3 | ||
:class-container: text-center | ||
- title: "**GitBook**" | ||
link: https://docs.gitbook.com/ | ||
image: https://avatars.githubusercontent.com/u/7111340?s=280&v=4 | ||
- title: "**Metaflow**" | ||
image: https://repository-images.githubusercontent.com/209120637/00b39080-1ddc-11ea-8710-59b484540700 | ||
link: https://docs.metaflow.org/ | ||
- title: "**Furo**" | ||
image: https://avatars.githubusercontent.com/u/3275593?v=4 | ||
link: https://pradyunsg.me/furo/quickstart | ||
- title: "**Docker**" | ||
link: https://docs.docker.com/ | ||
image: https://www.docker.com/wp-content/uploads/2022/03/vertical-logo-monochromatic.png | ||
- title: "**PyTorch**" | ||
link: https://pytorch.org/docs/stable/index.html | ||
image: https://pytorch.org/assets/images/pytorch-logo.png | ||
- title: "**Docasaurus**" | ||
link: https://docusaurus.io/docs | ||
image: https://d33wubrfki0l68.cloudfront.net/c088b7acfcf11100903c44fe44f2f2d7e0f30531/47727/img/docusaurus.svg | ||
- title: "**Material for MkDocs**" | ||
link: https://squidfunk.github.io/mkdocs-material/getting-started/ | ||
image: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/src/.icons/logo.svg | ||
``` |
File renamed without changes.
File renamed without changes.
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
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
Oops, something went wrong.