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: add the full option reference in the docs #1485

Merged
merged 9 commits into from
Oct 20, 2023

Commits on Sep 27, 2023

  1. Configuration menu
    Copy the full SHA
    3bb1672 View commit details
    Browse the repository at this point in the history

Commits on Oct 19, 2023

  1. trigger CI

    12rambau committed Oct 19, 2023
    Configuration menu
    Copy the full SHA
    c2e4724 View commit details
    Browse the repository at this point in the history
  2. refactor: remove line start

    12rambau committed Oct 19, 2023
    Configuration menu
    Copy the full SHA
    5cf5fad View commit details
    Browse the repository at this point in the history
  3. update to latest main (#12)

    * chore(i18n) catalan (pydata#1488)
    
    i18n: Translate sphinx.po in ca
    
    100% translated source file: 'sphinx.po'
    on 'ca'.
    
    Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com>
    
    * Build(deps): Bump postcss and css-loader (pydata#1494)
    
    Bumps [postcss](https://github.com/postcss/postcss) to 8.4.31 and updates ancestor dependency [css-loader](https://github.com/webpack-contrib/css-loader). These dependencies need to be updated together.
    
    
    Updates `postcss` from 8.4.21 to 8.4.31
    - [Release notes](https://github.com/postcss/postcss/releases)
    - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
    - [Commits](postcss/postcss@8.4.21...8.4.31)
    
    Updates `css-loader` from 3.6.0 to 6.8.1
    - [Release notes](https://github.com/webpack-contrib/css-loader/releases)
    - [Changelog](https://github.com/webpack-contrib/css-loader/blob/master/CHANGELOG.md)
    - [Commits](webpack-contrib/css-loader@v3.6.0...v6.8.1)
    
    ---
    updated-dependencies:
    - dependency-name: postcss
      dependency-type: indirect
    - dependency-name: css-loader
      dependency-type: direct:development
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    
    * Revert "Build(deps): Bump postcss and css-loader" (pydata#1509)
    
    Revert "Build(deps): Bump postcss and css-loader (pydata#1494)"
    
    This reverts commit 185a37a.
    
    * Update pst docs buttons (pydata#1502)
    
    * call them button-links
    
    * copy edit
    
    * docs: link back to GitHub from PyPI metadata (pydata#1504)
    
    This will add a "Source" link in the PyPI page.
    
    * navigation_with_keys = False (pydata#1503)
    
    * navigation_with_keys = False
    
    * None -> False
    
    * Apply suggestions from code review
    
    ---------
    
    Co-authored-by: Daniel McCloy <dan@mccloy.info>
    
    * fix: convert "stable" to actual version number (pydata#1512)
    
    * convert "stable" to actual version number
    
    * fix tests re: navigation_with_keys
    
    * try bumping autoapi
    
    * refactor: use nbsphinx as the default execution lib (pydata#1482)
    
    * refactor: use nbsphinx as the default execution lib
    
    * add nbstripout to the pre-commits'
    
    * add pandoc to the readthedocs deps
    
    * refactor: clean the notebook
    
    * move the example to the correct folder
    
    * fix: solve link issue
    
    * install pandoc in the test environment
    
    * fix: display of large table in executed cells
    
    * avoid Userwarnings from matplotlib
    
    * hide the matplotlib wrning management cell
    
    * Update readthedocs.yml
    
    * build: use pandoc_binary to install pandoc
    
    * docs: add reference to pandoc in the setup
    
    * update docs
    
    * remove pypandoc_binary
    
    * Update pyproject.toml
    
    Co-authored-by: gabalafou <gabriel@fouasnon.com>
    
    * ci: use back setup-pandoc
    
    * Trigger CI build
    
    ---------
    
    Co-authored-by: Gabriel Fouasnon <gabriel@fouasnon.com>
    
    * BUG - Clear alt_text in conf.py (pydata#1471)
    
    * comment out alt_text in conf.py
    
    * set alt_text to empty string
    
    * remove alt_text from conf.py
    
    * fix: use 12rambau fork until it's merged with nikeee repo (pydata#1517)
    
    * deps: drop support for Sphinx 5 (pydata#1516)
    
    * remove ref to myst-nb
    
    * update minimal supported version of sphinx
    
    * Fix: (webpack.config.js) css-loader API change (pydata#1508)
    
    * Fix: (webpack.config.js) css-loader API change
    
    The build was broken in
    <https://github.com/pydata/pydata-sphinx-theme/commit/185a37aa36820f77bffa4c87a772092e9e7cc380>/<https://github.com/pydata/pydata-sphinx-theme/pull/1494>.
    
    This change fixes the build, and it seems to be in accordance with the
    current API as described at <https://github.com/webpack-contrib/css-loader/blob/c6f36cf91ac61743a70e81cfb077faa0f8730ebe/README.md#boolean>.
    
    Closes <pydata#1507>.
    
    * dedup
    
    * restore version bump
    
    ---------
    
    Co-authored-by: Daniel McCloy <dan@mccloy.info>
    
    * Fix duplicate HTML IDs (pydata#1425)
    
    * Fix duplicate HTML IDs
    
    * fix tests
    
    * Do not animate the version admonitions colors. (pydata#1424)
    
    Otherwise a delay has to be added to the accessibility color
    contrast checks, to wait for the colors to fully transition.
    
    * BUG - Remove redundant ARIA in breadcrumb navigation (pydata#1426)
    
    * style(i18n): French Typo fixed (pydata#1430)
    
    * Add the ability to add a center section to the footer (pydata#1432)
    
    * Add a center section for the footer
    
    * Add docs for footer_center
    
    * Add a test site for the center footer
    
    * test it in our own docs
    
    * remove new test site
    
    * add footer test
    
    ---------
    
    Co-authored-by: Daniel McCloy <dan@mccloy.info>
    
    * Build(deps): Bump actions/checkout from 3 to 4 (pydata#1433)
    
    Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
    - [Release notes](https://github.com/actions/checkout/releases)
    - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
    - [Commits](actions/checkout@v3...v4)
    
    ---
    updated-dependencies:
    - dependency-name: actions/checkout
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    
    * Add dropdown_text argument to generate_header_nav_html (pydata#1423)
    
    * Add dropdown_text argument to generate_header_nav_html
    
    * Add a test, fix typo in theme.conf and remove header_dropdown_text from docs/conf.py
    
    * fixed?
    
    ---------
    
    Co-authored-by: Daniel McCloy <dan@mccloy.info>
    
    * fix: rollback ref and Id changes (pydata#1438)
    
    * bump: version 0.13.3 → 0.14.0  (pydata#1440)
    
    * bump version
    
    * update version switcher
    
    * back to dev
    
    * fix: change the z-index of the dropdown (pydata#1442)
    
    In order to be on top of the primary sidebar on small screens.
    
    * fix: set the same background for dark/light (pydata#1443)
    
    * fix: set the same background for dark/light
    et the same background color for all state of the search field. It is currently only applied when hovered
    
    * fix: wrong css selector
    
    * Update src/pydata_sphinx_theme/assets/styles/components/_search.scss
    
    * Update src/pydata_sphinx_theme/assets/styles/components/_search.scss
    
    * Fix duplicate HTML IDs
    
    * fix tests
    
    * unique_html_id
    
    * backwards-compat generate_header_nav_html
    
    * feedback review
    
    * update fixture
    
    * ughhhh...caching
    
    * code cleanup
    
    * fix test snapshot
    
    * put comment inside def
    
    ---------
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr>
    Co-authored-by: Stuart Mumford <stuart@cadair.com>
    Co-authored-by: Daniel McCloy <dan@mccloy.info>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
    Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com>
    
    * chore: build the devcontainer automatically in codespace (pydata#1483)
    
    * chore: build the devcontainer automaticallyin codespace
    
    * refactor: lint
    
    * add pandoc to the environment
    
    * Fix font color in search input box (pydata#1524)
    
    * Fix color
    
    * Use --pst-color-text-base
    
    * docs: add DecentralChain (pydata#1528)
    
    Co-authored-by: jourlez <josuecr.288@gmail.com>
    
    * Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po in ru [Manual Sync] (pydata#1527)
    
    i18n: Translate sphinx.po in ru [Manual Sync]
    
    96% of minimum 20% translated source file: 'sphinx.po'
    on 'ru'.
    
    Sync of partially translated files: 
    untranslated content is included with an empty translation 
    or source language content depending on file format
    
    Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com>
    
    * ignore transient errors in windows build CI (pydata#1520)
    
    * use warning list
    
    * clean up notebook
    
    * refactor to pass on all platforms?
    
    * simplify
    
    * fix logic
    
    * iterate backwards
    
    * fix plaform detection? also don't log unnecessarily�[H
    
    * ignore empty string warnings
    
    * remove notebook metawarning
    
    * Revert "remove notebook metawarning"
    
    This reverts commit 42f4672.
    
    * try again
    
    * debug the mysterious empty warning
    
    * escape color codes
    
    * import
    
    * triage by intermittency, not by platform; better var names
    
    * simplify
    
    * fix list.remove
    
    * undo what I broke
    
    * Update tests/utils/check_warnings.py
    
    ---------
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Daniel McCloy <dan@mccloy.info>
    Co-authored-by: gabalafou <gabriel@fouasnon.com>
    Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
    Co-authored-by: Adam Porter <adam@alphapapa.net>
    Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr>
    Co-authored-by: Stuart Mumford <stuart@cadair.com>
    Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
    Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com>
    Co-authored-by: jourlez <josuecr.288@gmail.com>
    12 people committed Oct 19, 2023
    Configuration menu
    Copy the full SHA
    02426cc View commit details
    Browse the repository at this point in the history
  4. fix: use internal reference

    12rambau committed Oct 19, 2023
    Configuration menu
    Copy the full SHA
    374c2da View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    1382d53 View commit details
    Browse the repository at this point in the history

Commits on Oct 20, 2023

  1. Configuration menu
    Copy the full SHA
    0b05e6b View commit details
    Browse the repository at this point in the history
  2. fix crossref?

    drammock committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    a17ebd3 View commit details
    Browse the repository at this point in the history
  3. fix crossref

    drammock committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    11c227a View commit details
    Browse the repository at this point in the history