Skip to content

Commit

Permalink
Merge branch 'main' into change-update-translations
Browse files Browse the repository at this point in the history
  • Loading branch information
tkoyama010 authored Aug 29, 2024
2 parents a2a73c4 + 5868d1e commit 935083a
Show file tree
Hide file tree
Showing 21 changed files with 581 additions and 201 deletions.
29 changes: 26 additions & 3 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"imageSize": 100,
"commit": false,
"commitConvention": "angular",
"contributorsSortAlphabetically": true,
"contributors": [
{
"login": "eriknw",
Expand Down Expand Up @@ -690,7 +691,8 @@
"contributions": [
"code",
"review",
"translation"
"translation",
"ideas"
]
},
{
Expand Down Expand Up @@ -730,7 +732,8 @@
"profile": "https://www.linkedin.com/in/ncclementi/",
"contributions": [
"code",
"review"
"review",
"translation"
]
},
{
Expand Down Expand Up @@ -762,7 +765,9 @@
"contributions": [
"code",
"review",
"doc"
"doc",
"translation",
"ideas"
]
},
{
Expand All @@ -783,6 +788,24 @@
"review",
"translation"
]
},
{
"login": "melissawm",
"name": "Melissa Weber Mendonça",
"avatar_url": "https://avatars.githubusercontent.com/u/3949932?v=4",
"profile": "http://melissawm.github.io",
"contributions": [
"question"
]
},
{
"login": "OriolAbril",
"name": "Oriol Abril-Pla",
"avatar_url": "https://avatars.githubusercontent.com/u/23738400?v=4",
"profile": "http://oriolabrilpla.cat",
"contributions": [
"question"
]
}
],
"contributorsPerLine": 7,
Expand Down
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ repos:
hooks:
- id: vale

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v3.1.0
- repo: https://github.com/rbubley/mirrors-prettier
rev: v3.3.3
hooks:
- id: prettier
types_or: [yaml, html, css, scss, javascript, json, toml]
Expand Down
144 changes: 76 additions & 68 deletions README.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions TRANSLATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ When you submit a PR for a translation, you should only include changes to one l

Translations PRs will be tagged with a label indicating the language to make them easier to identify and review. For example, contributions to the Spanish translation will be tagged with 'lang-es'.

TODO: This tagging could be automated with a GitHub action.
TODO: This tagging could be automated with a GitHub Actions.

When you submit the PR, make sure to include a short description of the changes you made and any context that might be helpful for the reviewer (e.g., you translated new strings, you reviewed fuzzy entries, you fixed typos, etc.)

Expand Down Expand Up @@ -340,7 +340,7 @@ TODO: There are many approaches here, some projects release a translation as soo

### How can I get help with my translation?

If you have any questions or need help with your translation, you can create an issue in the repository if you encounter any problems or need assistance.
If you have any questions or need help with your translation, you can create an issue in the repository.

TODO: Maybe [Discourse](https://pyopensci.discourse.group/) could be used as a way for contributors to ask for help with translations or the translation workflow?

Expand Down
39 changes: 39 additions & 0 deletions _static/pyos.css
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,45 @@ html[data-theme="dark"] {
--pyos-h1-color: var(--pyos-color-light);
}

/* --------------------------------------
De-jumble header items.
See https://github.com/pydata/pydata-sphinx-theme/pull/1784
*/

.bd-header .bd-header__inner {
padding: 0 1rem;
}

.bd-header .navbar-item {
height: unset;
max-height: unset;
}

@media (max-width: 960px) {
.bd-header .navbar-header-items {
flex-wrap: wrap;
row-gap: 0.5rem;
}
}

.bd-header .navbar-header-items__end,
.bd-header .navbar-header-items__center,
.bd-header .navbar-header-items__start {
flex-flow: nowrap;
}

.bd-header .navbar-header-items__start {
width: unset;
}

.bd-header .navbar-header-items__center {
margin-right: 0.25em !important;
}

.bd-header ul.navbar-nav {
flex-wrap: wrap;
}

/* -------------------------------------- */
/* Generated by https://gwfh.mranftl.com/ */

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ syntax. It is the default syntax used in Jupyter Notebooks. There are tools that
colored call out blocks and other custom elements to your documentation, you will
need to use either **myST** or **rST**.
1. [rST (ReStructured Text):](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html). **rST** is the native syntax that sphinx supports. rST was the default syntax used for documentation for many years. However, in recent years myST has risen to the top as a favorite for documentation given the flexibility that it allows.
1. [myST:](https://myst-parser.readthedocs.io/en/latest/intro.html) myST is a combination of vanilla of `markdown` and `rST` syntax. It is a nice option if you are comfortable writing markdown. `myst` is preferred by many because it offers both the rich functionality
1. [myST:](https://myst-parser.readthedocs.io/en/latest/intro.html) myST is a combination of `markdown` and `rST` syntax. It is a nice option if you are comfortable writing markdown. `myst` is preferred by many because it offers both the rich functionality
of rST combined with a simple-to-write markdown syntax.

While you can chose to use any of the syntaxes listed above, we suggest using
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ It [requires that you to add it to your Sphinx `conf.py` extension list and site

OpenGraph is an extension that allows you to add metadata to your documentation
content pages. [The OpenGraph protocol allows other websites to provide a
useful preview of the content on your page when shared](https://www.freecodecamp.org/news/what-is-open-graph-and-how-can-i-use-it-for-my-website/#what-is-open-graph). This is important
useful preview of the content on your page when shared](https://www.freecodecamp.org/news/what-is-open-graph-and-how-can-i-use-it-for-my-website/#heading-what-is-open-graph). This is important
for when the pages in your documentation are shared on social
media sites like Twitter and Mastodon and even for shares on
tools like Slack and Discourse.
9 changes: 9 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,15 @@ The first round of our community-developed, how to create a Python package tutor
:::
::::

::::{grid-item}
:::{card} ✿ Reference Guides ✿
:class-card: left-aligned

* [Command Line Reference Guide](/tutorials/command-line-reference)

:::
::::

:::::


Expand Down
Loading

0 comments on commit 935083a

Please sign in to comment.